# 查询客户加入群聊黑名单开关状态（平台号）

[异步回调] 查询客户加入群聊黑名单开关状态

商家通过调用“同步查询客户禁止加入客户群状态”这个接口可以获取机器人的某个客户禁止加入客户群的开关状态。

【注意】

仅版本1、3支持

请求方式：POST

请求地址：https://$basehost/gateway/qopen/CheckRestrictedJoiningGroupSwitch

body参数：

{
    "robot_id": "机器人id",
    "contact_id": "客户id"
}

字段	类型	必填	说明
robot_id	string	是	机器人id
contact_id	string	是	客户id

返回值：

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

返回说明

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

处理结果，异步返回值：

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

返回说明

字段	类型	说明
event_type	int	事件类型，本回调无事件码，请根据serial_no匹配回调
err_code	int	状态码，0为正常，非0代表错误
err_msg	string	错误信息
serial_no	string	操作编号
robot_id	string	机器人id
data	object	返回数据
data.contact_id	string	客户id
data.enable	bool	开关开启状态：true为开启，false为关闭

完整请求示例：

curl -X POST \
  https://$basehost/gateway/qopen/CheckRestrictedJoiningGroupSwitch \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
          "robot_id": "机器人id",
          "contact_id": "客户id"
}'

← 机器人同意入群申请获取加入群聊黑名单的客户列表 →