# 开启/关闭群聊验证

[异步回调]当机器人为群主或管理员时,可以调用该接口开启或关闭群聊验证。开启群聊验证后,群成员需要群主或管理员确认才能邀请好友进群。扫描二维码进群将同时停用。

请求方式:POST

请求地址:https://api.aquanliang.com/gateway/qopen/SwitchGroupChatValidation

body参数

{
    "robot_id": "机器人id",
    "group_id": "群id",
    "switch_status": 1
}
字段 类型 必填 说明
robot_id string 机器人id
group_id string 群id
switch_status int 开关开启状态:1为开启,2为关闭

返回值:

{
    "data": {
        "serial_no": "操作序列号"
    },
    "errcode": 0,
    "errmsg": ""
}

返回说明

字段 类型 说明
errcode int 状态码,0为正常,非0代表错误
errmsg string 错误信息
serial_no string 操作序列号

处理结果,异步返回值:

{
    "event_type": 300012,
    "err_code": 0,
    "err_msg": "",
	"serial_no": "操作序列号",
    "robot_id": "机器人id",
	"data": {
        "group_id": "群id",
        "enable": true
    }
}

返回说明

字段 类型 说明
event_type int 事件类型,300012
err_code int 状态码,0为正常,非0代表错误
err_msg string 错误信息
serial_no string 操作序列号
robot_id string 机器人id
data object 返回数据
data.group_id string 群id
data.enable bool 开关开启状态

完整请求示例:

curl -X POST \
  https://api.aquanliang.com/gateway/qopen/SwitchGroupChatValidation \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
        "robot_id": "机器人id",
        "group_id": "群id",
        "switch_status": 1
      }'