该接口用于获取配置过客户群管理的客户群列表。
请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/list?access_token=ACCESS_TOKEN
{
"status_filter": 0,
"owner_filter": {
"userid_list": ["abel"]
},
"cursor" : "r9FqSqsI8fgNbHLHE5QoCP50UIg2cFQbfma3l2QsmwI",
"limit" : 10
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
status_filter | 否 | 客户群跟进状态过滤。 0 - 所有列表(即不过滤) 1 - 离职待继承 2 - 离职继承中 3 - 离职继承完成 默认为0 |
owner_filter | 否 | 群主过滤。 如果不填,表示获取应用可见范围内全部群主的数据(但是不建议这么用,如果可见范围人数超过1000人,为了防止数据包过大,会报错 81017) |
owner_filter.userid_list | 否 | 用户ID列表。最多100个 |
cursor | 否 | 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用不填 |
limit | 是 | 分页,预期请求的数据量,取值范围 1 ~ 1000 |
如果不指定 owner_filter,会拉取应用可见范围内的所有群主的数据,但是不建议这样使用。如果可见范围内人数超过1000人,为了防止数据包过大,会报错 81017。此时,调用方需通过指定 owner_filter 来缩小拉取范围
旧版接口以offset+limit分页,要求offset+limit不能超过50000,该方案将废弃,请改用cursor+limit分页
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"group_chat_list": [{
"chat_id": "wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
"status": 0
}, {
"chat_id": "wrOgQhDgAAcwMTB7YmDkbeBsAAAA",
"status": 0
}],
"next_cursor":"tJzlB9tdqfh-g7i_J-ehOz_TWcd7dSKa39_AqCIeMFw"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
group_chat_list | 客户群列表 |
group_chat_list.chat_id | 客户群ID |
group_chat_list.status | 客户群跟进状态。 0 - 跟进人正常 1 - 跟进人离职 2 - 离职继承中 3 - 离职继承完成 |
next_cursor | 分页游标,下次请求时填写以获取之后分页的记录。如果该字段返回空则表示已没有更多数据 |