# 设置客户加入群聊黑名单

[异步回调]设置客户加入群聊黑名单

可通过调用该接口设置客户好友【加入群聊黑名单】开关状态。若开启该开关,该客户将不能加入机器人创建的客户群;若该用户已经在机器人创建的客户群中也会被移出。

请求方式:POST

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

body参数

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

返回值:

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

返回说明

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

处理结果,异步返回值:

{
    "event_type": 200015,
    "serial_no": "操作序列号",
    "err_code": 0,
    "err_msg": "success",
    "robot_id": "机器人id",
    "data": {
      "contact_id": "客户id",
      "enable": true
    }
}

返回说明

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

完整请求示例:

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