获取客户群详情

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

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

请求方式:POST(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get?access_token=ACCESS_TOKEN

参数说明:

{
    "chat_id":"wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA"
}
参数 必须 说明
access_token 调用接口凭证
chat_id 客户群ID

权限说明:

返回结果:

{
    "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"
            }
        }, {
            "userid": "sam",
            "type": 1,
            "join_time": 1572505491,
            "join_scene": 1
        }, {
            "userid": "wmOgQhDgAAuXFJGwbve4g4iXknfOAAAA",
            "type": 2,
            "unionid": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
            "join_time": 1572505491,
            "join_scene": 1
        }],
        "admin_list": [{
            "userid": "sam"
        }, {
            "userid": "pony"
        }]
    }
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
group_chat 客户群详情
group_chat.chat_id 客户群ID
group_chat.name 群名
group_chat.owner 群主ID
group_chat.create_time 群的创建时间
group_chat.notice 群公告
group_chat.member_list 群成员列表
group_chat.member_list.userid 群成员id
group_chat.member_list.type 成员类型。
1 - 企业成员
2 - 外部联系人
group_chat.member_list.unionid 外部联系人在微信开放平台的唯一身份标识(微信unionid),通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当群成员类型是微信用户(包括企业成员未添加好友),且企业或第三方服务商绑定了微信开发者ID有此字段查看绑定方法
group_chat.member_list.join_time 入群时间
group_chat.member_list.join_scene 入群方式。
1 - 由成员邀请入群(直接邀请入群)
2 - 由成员邀请入群(通过邀请链接入群)
3 - 通过扫描群二维码入群
group_chat.member_list.invitor 邀请者。目前仅当是由本企业内部成员邀请入群时会返回该值
group_chat.member_list.invitor.userid 邀请者的userid
group_chat.admin_list 群管理员列表
group_chat.admin_list.userid 群管理员userid
© 1998 - 2021 Tencent Inc. All Rights Reserved