# 设置或取消会话免打扰【同步】
请求方式:POST
请求地址:https://$basehost/gateway/qopen/SetContactShield
body参数:
{
"robot_id": "机器人id",
"contact_id":"群openid或客户openid",
"switch_type":1,
"is_group": true
}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| robot_id | string | 是 | 机器人openid |
| contact_id | string | 是 | 群openid或客户openid |
| switch_type | int | 是 | 开关开启状态:1为开启免打扰,2为关闭免打扰 |
| is_group | bool | 否 | 会话类型:true为群聊,false为私聊,默认不填为私聊 |
返回值:
{
"errcode": 0,
"errmsg": "",
"data": {
},
"hint": ""
}
| 字段 | 类型 | 说明 |
|---|---|---|
| errcode | int | 错误码 |
| errmsg | string | 错误描述 |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/SetContactShield \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id",
"contact_id":"群openid或客户openid",
"switch_type":1,
"is_group": true
}'
← 接龙说明 新群聊 - 20002 →