# 设置群禁止互相添加为联系人

[异步回调]设置群禁止互相添加为联系人

可通过调用该接口设置群【禁止互相添加为联系人】开关状态。若开启该开关,群成员仅可添加群主为联系人。

请求方式:POST

请求地址:https://$basehost/gateway/qopen/SetGroupBanAddFriend

body参数

{
  "robot_id": "机器人id"
  "group_id": "群id",
  "enable": true,
}
字段 类型 必填 说明
robot_id string 机器人id
group_id string 群id
enable bool true为开启 false为关闭(默认关闭)

返回值:

{
  "data": {
    "serial_no": ""
  },
  "errmsg": "",
  "errcode": 0,
  "hint": ""
}

返回说明

字段 类型 说明
errcode int 状态码,0为正常,非0代表错误
errmsg string 错误信息
data json json返回值
serial_no string 请求序列号
hint string 请求日志ID

处理结果,异步返回值:

{
  "data": {
  },
  "err_code": 0,
  "err_msg": "success",
  "event_type": 40035,
  "hint": "请求日志id",
  "robot_id": "机器人id",
  "serial_no": "请求序列号"
}
字段 类型 说明
event_type int 事件类型,40035
err_code int 状态码,0为正常,非0代表错误
err_msg string 错误信息
serial_no string 请求序列号
data object 返回数据

完整请求示例:

curl -X POST \
  https://$basehost/gateway/qopen/SetGroupBanAddFriend \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
          "robot_id": "机器人id",
          "group_id": "群id",
          "enable": true
        }'

最后更新时间: 2024/11/21 13:58:28