请求地址
POST https://api.qingluanbot.com/qingluan/api/personal/getInfo
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/personal/getInfo' \
-H 'X-Qingluan-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"ql_appid": "inst_xxxxxxxxxxxx"
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
ql_appid | string | 必填 | 青鸾实例 ID，形如 inst_xxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | ql_appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {
"alias": "示例别名",
"attr": 142672192,
"attr2": 240779916,
"attr3": 0,
"bindEmailStatus": 1,
"birthday": "2000-09-01 12:00:00",
"bizMail": "xiaoyi@taichuinfo.cn",
"bizUin": 1,
"collegeIdentity": 0,
"corpId": 1000000000000002,
"customInfo": {},
"dispOrder": 0,
"emailAddr": "",
"englishName": "XiaoYi-FuWuZhiChi",
"gender": 1,
"gid": 1000000000000004,
"holidayInfo": {
"createTime": 0,
"holidayDesc": "",
"holidayGenerateSrc": 0,
"holidayIconIndex": 0,
"holidayInfoId": 0,
"holidayStatus": 0,
"holidayStatusNew": 0,
"oldHolidayIconIndex": 0,
"vacationSyncType": 0
},
"iconUrl": "<省略>",
"internationCode": "86",
"inviteVid": 1000000000000005,
"isNameVerified": true,
"isSyncInnerPosition": true,
"job": "",
"mainPartyId": 1000000000000003,
"mobile": "",
"mobileAreaCode": 0,
"name": "示例昵称",
"nameVerifyStatus": 1,
"number": "",
"personalWorkType": 0,
"phone": "",
"position": "",
"realName": "示例用户",
"superiors": [
{}
],
"tencentInfo": {},
"uin": 1000000000000001,
"unionId": "<省略>",
"vCode": "<省略>",
"vCorpUseStatus": 1000,
"xcxStyle": 0
}
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
ql_appid。 - 请求头携带
X-Qingluan-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。