第三方应用开发 服务端API 客户联系 客户群管理 获取客户群详情
获取客户群详情

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

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

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

参数说明:

{
    "chat_id":"wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
	"need_name" : 1
}
参数必须说明
access_token调用接口凭证
chat_id客户群ID
need_name是否需要返回群成员的名字group_chat.member_list.name。0-不返回;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"
		}]
	}
}

参数说明:

参数说明
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有此字段(查看绑定方法)。第三方不可获取,上游企业不可获取下游企业客户的unionid字段
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.member_list.group_nickname在群里的昵称
group_chat.member_list.name名字。仅当 need_name = 1 时返回
如果是微信用户,则返回其在微信中设置的名字
如果是企业微信联系人,则返回其设置对外展示的别名或实名
group_chat.admin_list群管理员列表
group_chat.admin_list.userid群管理员userid
上一篇
获取客户群列表
下一篇
客户群opengid转换