企业可通过此接口获取到由指定的获客链接添加的客户列表。
请求方式: POST(HTTP)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/customer?access_token=ACCESS_TOKEN
请求示例
{
"link_id":"LINK_ID",
"limit":1000,
"cursor":"CURSOR"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
link_id | 是 | 获客链接id |
limit | 否 | 返回的最大记录数,整型,最大值1000 |
cursor | 否 | 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填 |
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"customer_list":
[
{
"external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACAAA",
"userid":"zhangsan",
"chat_status":0,
"state":"CHANNEL_A"
},
{
"external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACAAA",
"userid":"lisi",
"chat_status":0,
"state":"CHANNEL_B"
},
{
"external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mBCBBB",
"userid":"rocky",
"chat_status":1,
"state":"CHANNEL_A"
}
],
"next_cursor":"CURSOR"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
customer_list.external_userid | 客户external_userid |
customer_list.userid | 通过获客链接添加此客户的跟进人userid |
customer_list.chat_status | 会话状态,0-客户未发消息 1-客户已发送消息 2-客户发送消息状态未知 |
customer_list.state | 用于区分客户具体是通过哪个获客链接进行添加,用户可在获客链接后拼接customer_channel=自定义字符串 ,字符串不超过64字节,超过会被截断。通过点击带有customer_channel参数的链接获取到的客户,调用获客信息接口或获取客户详情接口时,返回的state参数即为链接后拼接自定义字符串 |
next_cursor | 分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空 |