获取客户群详情

POST

/cgi-bin/externalcontact/groupchat/get

服务端API企业内部开发第三方应用开发

通过客户群ID，获取详情。包括群名、群成员列表、群成员入群时间、入群方式。（客户群是由具有客户群使用权限的成员创建的外部群）

需注意的是，如果发生群信息变动，会立即收到群变更事件，但是部分信息是异步处理，可能需要等一段时间调此接口才能得到最新结果

权限说明:

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

文档ID: 19412
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/92122
https://open.work.weixin.qq.com/api/doc/90001/90143/92707

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chat_id":"wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
    "need_name" : 1
}'

响应示例

{
  "errcode": 0,
  "errmsg": "ok",
  "group_chat": {
    "chat_id": "wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
    "name": "销售客服群",
    "owner": "ZhuShengBen",
    "create_time": 1572505490,
    "notice": "文明沟通，拒绝脏话",
    "member_list": [
      {
        "userid": "abel",
        "type": 1,
        "join_time": 1572505491,
        "join_scene": 1,
        "invitor": {
          "userid": "jack"
        },
        "group_nickname": "客服小张",
        "name": "张三丰"
      },
      {
        "userid": "wmOgQhDgAAuXFJGwbve4g4iXknfOAAAA",
        "type": 2,
        "unionid": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
        "join_time": 1572505491,
        "join_scene": 1,
        "group_nickname": "顾客老王",
        "name": "王语嫣"
      }
    ],
    "admin_list": [
      {
        "userid": "sam"
      },
      {
        "userid": "pony"
      }
    ]
  }
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

chat_id

string

客户群ID

必需

need_name

integer

可选

是否需要返回群成员的名字group_chat.member_list.name。0-不返回；1-返回。默认不返回

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

group_chat

object

客户群详情

可选

owner

string

群主ID

可选

create_time

integer <int32>

群的创建时间

可选

name

string

群名

可选

member_list

array [object {7}]

群成员列表

可选

admin_list

array [object {1}]

群管理员列表

可选

chat_id

string

客户群ID

可选

notice

string

群公告

可选

errmsg

string

可选

对返回码的文本描述内容

修改于 2022-01-14 04:25:42

获取客户群列表

客户群opengid转换