配置客户群进群方式

POST

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

企业内部开发/客户联系/联系我与客户入群方式/客户群「加入群聊」管理

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

责任人：未设置

企业可以在管理后台-客户联系中配置「加入群聊」的二维码或者小程序按钮，客户通过扫描二维码或点击小程序上的按钮，即可加入特定的客户群。
企业可通过此接口为具有客户联系功能的成员生成专属的二维码或者小程序按钮。
如果配置的是小程序按钮，需要开发者的小程序接入小程序插件。
注意:
通过API添加的配置不会在管理端进行展示，每个企业可通过API最多配置50万个「加入群聊」(与「联系我」共用50万的额度)。
room_base_name 和 room_base_id 两个参数配合，用于指定自动新建群的群名
例如，假如 room_base_name = "销售客服群", room_base_id = 10
那么，自动创建的第一个群，群名为“销售客服群10”；自动创建的第二个群，群名为“销售客服群11”，依次类推

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

ACCESS_TOKEN

Body 参数application/json

scene

integer

必需

场景。 1 - 群的小程序插件 2 - 群的二维码插件

remark

string

可选

联系方式的备注信息，用于助记，超过30个字符将被截断

auto_create_room

integer

可选

当群满了后，是否自动新建群。0-否；1-是。默认为1

room_base_name

string

可选

自动建群的群名前缀，当auto_create_room为1时有效。最长40个utf8字符

room_base_id

integer

可选

自动建群的群起始序号，当auto_create_room为1时有效

chat_id_list

array[string]

必需

使用该配置的客户群ID列表，支持5个。见客户群ID获取方法

state

string

可选

企业自定义的state参数，用于区分不同的入群渠道。不超过30个UTF-8字符如果有设置此参数，在调用获取客户群详情接口时会返回每个群成员对应的该参数值，详见文末附录2

示例

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/cgi-bin/externalcontact/groupchat/add_join_way?access_token=ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scene": 2,
    "remark": "aa_remark",
    "auto_create_room": 1,
    "room_base_name": "销售客服群",
    "room_base_id": 10,
    "chat_id_list": [
        "wrOgQhDgAAH2Yy-CTZ6POca8mlBEdaaa",
        "wrOgQhDgAALPUthpRAKvl7mgiQRwAAA"
    ],
    "state": "klsdup3kj3s1"
}'

返回响应

🟢200成功

application/json

Body

errcode

integer

返回码

必需

errmsg

string

必需

对返回码的文本描述内容

config_id

string

配置id

必需

示例

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

删除企业已配置的「联系我」方式

获取客户群进群方式配置