# [废弃]获取单个标签下的客户列表
[异步回调]获取单个标签下的客户列表
【提示】建议直接使用企微自建应用,调用企微开平接口
获取单个标签下的客户列表频率限制
每分钟/次 |
---|
100 |
注意: 目前获取标签下的客户列表以分页的形式返回,默认每页返回500个好友,若标签下的客户总量大于500人,则以多条回调返回。每条回调大约费时3-4秒。若好友数据量较大,请耐心等候回调返回~
请求方式:POST
请求地址:https://$basehost/gateway/qopen/GetCustomerByTag
body参数:
{
"robot_id": "机器人id",
"tag_id": "标签id"
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
robot_id | string | 是 | 机器人id |
tag_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": 702008,
"serial_no": "操作序列号",
"robot_id": "机器人id",
"err_code": 0,
"err_msg": "success",
"data": {
"tag_id": "标签id",
"total_count": 100,
"total_page": 10,
"page_index": 1,
"page_size": 100,
"members": [
{
"contact_id": "客户id",
"name": "客户姓名",
"base64_name": "base64加密后的客户姓名",
"profile_photo": "客户头像url",
"company": "客户所属的企业"
}
]
}
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
event_type | int | 事件类型,702008 |
serial_no | string | 操作序列号 |
err_code | int | 状态码,0为正常,非0代表错误 |
err_msg | string | 错误信息 |
robot_id | string | 机器人id |
data | object | 返回数据 |
data.tag_id | string | 标签id |
data.total_count | int | 标签下的客户总数 |
data.total_page | int | 返回的客户列表总页数 |
data.page_index | int | 当前的页面数 |
data.page_size | int | 当前页面返回的客户好友数量 |
data.members | array | 客户信息 |
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].company | string | 客户所属的企业 |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/GetCustomerByTag \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id",
"tag_id": "标签id"
}'
← [废弃]编辑标签名称 [废弃]创建企业标签 →