开发者中心
首页
教程
接口
社区
工具
企业内部开发
快速入门 服务端API 客户端API 附录 更新日志 联系我们
企业内部开发 服务端API 客户联系 联系我与客户入群方式 客户群「加入群聊」管理
客户群「加入群聊」管理
最后更新：2023/12/01
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
客户群「加入群聊」管理
最后更新：2023/12/01

目录

  • 权限说明
  • 配置客户群进群方式
  • 获取客户群进群方式配置
  • 更新客户群进群方式配置
  • 删除客户群进群方式配置
  • 附录：获取客户群详情，返回state参数

    • 企业可通过接口配置客户群「加入群聊」的方式。配置后，客户通过扫描群二维码或点击小程序上的按钮，即可进入企业的客户群

     

    权限说明

    调用的应用需要满足如下的权限：

    应用类型权限要求
    自建应用配置到「客户联系 - 可调用接口的应用」中
    代开发应用具有企业客户权限-客户群-配置「加入群聊」二维码权限，且已购买「加入群聊」增值接口
    第三方应用具有企业客户权限-客户群-配置「加入群聊」二维码权限，且已购买「加入群聊」增值接口
    提示
    应用仅能获取和管理由本应用创建的「加入群聊」二维码/小程序组件

    注： 从2023年12月1日0点起，不再支持通过系统应用secret调用接口，存量企业暂不受影响 查看详情

    配置客户群进群方式

    企业可调用此接口来生成并配置「加入群聊」的二维码或者小程序按钮，客户通过扫描二维码或点击小程序上的按钮，即可加入特定的客户群
    如果配置的是小程序按钮，需要开发者的小程序接入小程序插件。

    通过API添加的配置不会在管理端进行展示，每个企业可通过API最多配置50万个「加入群聊」(与「联系我」共用50万的额度)

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

    请求示例：

    {
	"scene": 2,
	"remark": "aa_remark",
	"auto_create_room": 1,
	"room_base_name" : "销售客服群",
	"room_base_id" : 10,
	"chat_id_list": [
		"wrOgQhDgAAH2Yy-CTZ6POca8mlBEdaaa",
		"wrOgQhDgAALPUthpRAKvl7mgiQRwAAA"
	],
	"state" : "klsdup3kj3s1"
}

    参数说明：

    参数必须说明
    access_token是调用接口凭证
    scene是场景。
    1 - 群的小程序插件
    2 - 群的二维码插件
    remark否联系方式的备注信息，用于助记，超过30个字符将被截断
    auto_create_room否当群满了后，是否自动新建群。0-否；1-是。 默认为1
    room_base_name否自动建群的群名前缀，当auto_create_room为1时有效。最长40个utf8字符
    room_base_id否自动建群的群起始序号，当auto_create_room为1时有效
    chat_id_list是使用该配置的客户群ID列表，最多支持5个。见客户群ID获取方法
    state否企业自定义的state参数，用于区分不同的入群渠道。不超过30个UTF-8字符
    如果有设置此参数，在调用获取客户群详情接口时会返回每个群成员对应的该参数值，详见文末附录2
    room_base_name 和 room_base_id 两个参数配合，用于指定自动新建群的群名
    例如，假如 room_base_name = "销售客服群", room_base_id = 10
    那么，自动创建的第一个群，群名为“销售客服群10”；自动创建的第二个群，群名为“销售客服群11”，依次类推

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok",
	"config_id": "9ad7fa5cdaa6511298498f979c472aaa"
}

    参数说明：

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    config_id配置id

     

    获取客户群进群方式配置

    获取企业配置的群二维码或小程序按钮。
    请求方式：POST（HTTPS）
    请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get_join_way?access_token=ACCESS_TOKEN

    请求示例：

    {
    "config_id":"9ad7fa5cdaa6511298498f979c472aaa"
}

    参数说明：

    参数必须说明
    access_token是调用接口凭证
    config_id是联系方式的配置id

     

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok",
	"join_way": {
		"config_id": "9ad7fa5cdaa6511298498f979c472aaa",
		"scene": 2,
		"remark": "aa_remark",
		"auto_create_room": 1,
		"room_base_name" : "销售客服群",
		"room_base_id" : 10,
		"chat_id_list": ["wrOgQhDgAAH2Yy-CTZ6POca8mlBEdaaa", "wrOgQhDgAALPUthpRAKvl7mgiQRw_aaa"],
		"qr_code": "http://p.qpic.cn/wwhead/nMl9ssowtibVGyrmvBiaibzDtp703nXuzpibnKtbSDBRJTLwS3ic4ECrf3ibLVtIFb0N6wWwy5LVuyvMQ22/0",
		"state" : "klsdup3kj3s1"
	}
}

    参数说明：

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    join_way配置详情
    config_id新增联系方式的配置id
    scene场景。
    1 - 群的小程序插件
    2 - 群的二维码插件
    remark联系方式的备注信息，用于助记，超过30个字符将被截断
    auto_create_room当群满了后，是否自动新建群。0-否；1-是。 默认为1
    room_base_name自动建群的群名前缀，当auto_create_room为1时有效。最长40个utf8字符
    room_base_id自动建群的群起始序号，当auto_create_room为1时有效
    chat_id_list使用该配置的客户群ID列表。见客户群ID获取方法
    qr_code联系二维码的URL或小程序插件的URL
    state企业自定义的state参数，用于区分不同的入群渠道。不超过30个UTF-8字符
    如果有设置此参数，在调用获取客户群详情接口时会返回每个群成员对应的该参数值，详见文末附录2

    更新客户群进群方式配置

    更新进群方式配置信息。注意：使用覆盖的方式更新。

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

    请求示例：

    {
	"config_id": "9ad7fa5cdaa6511298498f979c4722de",
	"scene": 2,
	"remark": "bb_remark",
	"auto_create_room": 1,
	"room_base_name" : "销售客服群",
	"room_base_id" : 10,
	"chat_id_list": ["wrOgQhDgAAH2Yy-CTZ6POca8mlBEdaaa", "wrOgQhDgAALPUthpRAKvl7mgiQRw_aaa"],
	"state" : "klsdup3kj3s1"
}

    参数说明：

    参数必须说明
    access_token是调用接口凭证
    config_id是企业联系方式的配置id
    scene是场景。
    1 - 群的小程序插件
    2 - 群的二维码插件
    remark否联系方式的备注信息，用于助记，超过30个字符将被截断
    auto_create_room否当群满了后，是否自动新建群。0-否；1-是。 默认为1
    room_base_name否自动建群的群名前缀，当auto_create_room为1时有效。最长40个utf8字符
    room_base_id否自动建群的群起始序号，当auto_create_room为1时有效
    chat_id_list是使用该配置的客户群ID列表，最多支持5个。见客户群ID获取方法
    state否企业自定义的state参数，用于区分不同的入群渠道。不超过30个UTF-8字符
    如果有设置此参数，在调用获取客户群详情接口时会返回每个群成员对应的该参数值，详见文末附录2

     

    返回结果：

    {
   "errcode": 0,
   "errmsg": "ok"
}

    参数说明：

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容

     

    删除客户群进群方式配置

    删除一个进群方式配置。

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

    请求示例：

    {
	"config_id":"42b34949e138eb6e027c123cba77faaa"
}

    参数说明：

    参数必须说明
    access_token是调用接口凭证
    config_id是企业联系方式的配置id

     

    返回结果：

    {
   "errcode": 0,
   "errmsg": "ok",
}

    参数说明：

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容

    附录：获取客户群详情，返回state参数

    如果在配置入群方式时，配置了state参数，那么在获取客户群详情时，通过该方式入群的成员，会额外获取到相应的state参数。此处单独说明带state参数的返回示例。

    返回示例：

    {
	"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": 3,
			"state" : "klsdup3kj3s1",
			"invitor": {
				"userid": "jack"
			}
		}, {
			"userid": "sam",
			"type": 1,
			"join_time": 1572505491,
			"join_scene": 1
		}],
		"admin_list": [{
			"userid": "sam"
		}, {
			"userid": "pony"
		}]
	}
}

    参数说明：

    参数说明
    group_chat.member_list.state该成员入群方式对应的state参数
    上一篇
    客户联系「联系我」管理
    下一篇
    概述