# 获取其他联系人列表
[异步回调] 获取其他联系人列表
商家通过调用“获取其他联系人列表”这个接口可以获取到机器人其他联系人列表。
其他联系人产生场景:
1、机器人在没有客户及客户群联系权限但有外部联系人权限时,添加的客户均为外部联系人。
2、机器人恢复客户及客户群联系权限时,之前没有该权限所添加的客户均为其他联系人。
请求方式:POST
请求地址:https://$basehost/gateway/qopen/OtherExternalContacts
body参数:
{
"robot_id": "机器人id"
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
robot_id | string | 是 | 机器人id |
返回值:
{
"data": {
"serial_no": "操作序列号"
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
errcode | int | 状态码,0为正常,非0代表错误 |
errmsg | string | 错误信息 |
data | json | json返回值 |
serial_no | string | 请求序列号 |
hint | string | 请求日志ID |
处理结果,异步返回值:
{
"event_type": 200016,
"serial_no": "操作序列号",
"err_code": 0,
"err_msg": "success",
"robot_id": "机器人id",
"data": {
"members": [
{
"account_id": "企业微信userid",
"contact_id": "客户id",
"name": "姓名",
"base64_name": "BASE64编码过后的用户姓名",
"profile_photo": "头像url",
"gender": 1,
"is_verified": true,
"real_name": "实名姓名",
"alias": "别名",
"base64_alias": "BASE64编码过后的用户别名",
"remark_alias": "联系人的备注",
"base64_remark_alias": "base64加密后的联系人备注",
"description": "好友描述",
"company": "所属企业",
"mobile": "手机号",
"add_time": "添加时间"
}
]
}
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
event_type | int | 事件类型,200016 |
serial_no | string | 操作序列号 |
err_code | int | 状态码,0为正常,非0代表错误 |
err_msg | string | 错误信息 |
robot_id | string | 机器人id |
data | object | 返回数据 |
data.members[x].account_id | string | 企业微信userid |
data.members[x].contact_id | string | 客户id |
data.members[x].name | string | 姓名 |
data.members[x].base64_name | string | BASE64编码过后的用户姓名 |
data.members[x].profile_photo | string | 头像url |
data.members[x].gender | int | 性别:1男 2女 |
data.members[x].is_verified | bool | 是否可加客户好友:true可加;false不可加(非实名账号,无法加客户为好友) |
data.members[x].real_name | string | 实名姓名 |
data.members[x].alias | string | 别名 |
data.members[x].base64_alias | string | BASE64编码过后的用户别名 |
data.members[x].remark_alias | string | 联系人的备注 |
data.members[x].base64_remark_alias | string | base64加密后的联系人备注 |
data.members[x].description | string | 好友描述 |
data.members[x].company | string | 所属企业 |
data.members[x].mobile | string | 手机号 |
data.members[x].add_time | string | 添加时间 |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/OtherExternalContacts \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id"
}'