请求地址
POST https://api.qingluanbot.com/qingluan/api/contact/fetchUsersProfileBatch
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/contact/fetchUsersProfileBatch' \
-H 'X-Qingluan-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"ql_appid": "inst_xxxxxxxxxxxx",
"nodeList": [
{
"type": 1,
"vid": 1000000000000001
}
]
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
ql_appid | string | 必填 | 青鸾实例 ID，形如 inst_xxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
nodeList | array<object> | 必填 | 节点列表，元素形如 {"vid": 1688800000000001, "type": 1}。成员节点用 vid 字段（不是 id）；type：1=成员，2=部门。 |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | ql_appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {
"isTrimUserInfo": false,
"patchList": [
{
"isDelete": true,
"member": {
"attr": 8388608,
"attr2": 268435456,
"attr3": 1,
"bindEmailStatus": 1,
"bizUin": 1,
"partyId": 0,
"uin": 1000000000000001
},
"nodeType": 1
}
]
}
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
ql_appid。 - 请求头携带
X-Qingluan-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。