# 获取加入群聊黑名单的客户列表
[异步回调] 获取加入群聊黑名单的客户列表
请求方式:POST
请求地址:https://$basehost/gateway/qopen/GetCustomersRestrictedJoiningGroup
【注意】
- 仅版本1、3支持
body参数:
{
"robot_id": "机器人id"
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
robot_id | string | 是 | 机器人id |
返回值:
{
"data": {
"serial_no": "xxxxxx"
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
errcode | int | 状态码,0为正常,非0代表错误 |
errmsg | string | 错误信息 |
data | json | json返回值 |
serial_no | string | 操作序列号 |
hint | string | 请求日志ID |
处理结果,异步返回值:
{
"event_type": 200025,
"err_code": 0,
"err_msg": "",
"serial_no": "请求序列号",
"robot_id": "机器人id",
"data": {
"contact_list": [
{
"contact_id": "客户id",
"name": "名字",
"base64_name": "名字base64值",
"profile_photo": "照片url",
"company": "公司"
}
]
}
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
event_type | int | 事件类型,200025 |
err_code | int | 状态码,0为正常,非0代表错误 |
err_msg | string | 错误信息 |
serial_no | string | 请求序列号 |
robot_id | string | 机器人编号 |
data | object | 返回数据 |
data.contact_list | array | 客户信息列表 |
data.contact_list[x].contact_id | string | 客户id |
data.contact_list[x].name | string | 名字 |
data.contact_list[x].base64_name | string | 名字base64值 |
data.contact_list[x].profile_photo | string | 照片url |
data.contact_list[x].company | string | 公司 |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/GetCustomersRestrictedJoiningGroup \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id"
}'