Appearance
设置聊天免打扰
开启或关闭指定好友、群聊的消息免打扰。
接口地址: POST /setDisturb
前置条件
- 微信实例已登录,并已获得可用的
wId。 - 已确认目标
chatRoomId是好友 ID 或当前微信实例所在的群 ID。 - 免打扰状态会影响人工客服处理消息的提醒方式,请按业务规则操作。
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
wId | 是 | string | 登录实例标识 |
chatRoomId | 是 | string | 好友 ID 或群 ID |
type | 是 | int | 0 开启免打扰,1 关闭免打扰 |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
code | string | 1000 成功,1001 失败 |
message | string | 反馈信息 |
data | null | 成功时通常为空 |
请求示例
json
{
"wId": "01377f33-544c-4dc4-9184-bcbbcd3b05d0",
"chatRoomId": "24608539283@chatroom",
"type": 0
}成功响应
json
{
"code": "1000",
"message": "成功",
"data": null
}错误响应
json
{
"code": "1001",
"message": "失败",
"data": null
}使用建议
- 设置成功后即刻生效;手机端显示可能有短暂延迟。
- 不建议把免打扰作为消息接收过滤条件,业务系统仍应按 Webhook 回调处理消息。
