获取客户群列表

POST

http://127.0.0.1/cgi-bin/externalcontact/groupchat/list

最后修改时间：2022-08-30 03:03:36

责任人：未设置

该接口用于获取配置过客户群管理的客户群列表。

如果不指定 owner_filter，会拉取应用可见范围内的所有群主的数据，但是不建议这样使用。如果可见范围内人数超过1000人，为了防止数据包过大，会报错 81017。此时，调用方需通过指定 owner_filter 来缩小拉取范围
旧版接口以offset+limit分页，要求offset+limit不能超过50000，该方案将废弃，请改用cursor+limit分页

权限说明:

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
第三方应用需具有“企业客户权限->客户基础信息”权限
对于第三方/自建应用，群主必须在应用的可见范围。

文档ID: 19409
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/92120
https://open.work.weixin.qq.com/api/doc/90001/90143/93414

请求参数

Query 参数

Body 参数application/json

示例

{
    "status_filter": 0,
    "owner_filter": {
        "userid_list": [
            "abel"
        ]
    },
    "cursor": "r9FqSqsI8fgNbHLHE5QoCP50UIg2cFQbfma3l2QsmwI",
    "limit": 10
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/externalcontact/groupchat/list?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status_filter": 0,
    "owner_filter": {
        "userid_list": [
            "abel"
        ]
    },
    "cursor": "r9FqSqsI8fgNbHLHE5QoCP50UIg2cFQbfma3l2QsmwI",
    "limit": 10
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "errcode": 0,
    "next_cursor": "string",
    "errmsg": "string",
    "group_chat_list": [
        {
            "chat_id": "string",
            "status": 0
        }
    ]
}

修改于 2022-08-30 03:03:36

分配离职成员的客户群

获取客户群详情