文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>即时通信 IM

管理员设置全局免打扰选项

最近更新时间：2026-05-25 16:41:56

我的收藏

本页目录：

功能说明

App 后台可以通过该接口为一个账号设置全局免打扰选项。
只能管理员调用。
调用该 RestAPI 前必须在控制台开启全局免打扰选项。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/im_msg_db_logic/admin_set_do_not_disturb?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔：adminapikr.im.qcloud.com
东京：adminapijpn.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
孟买：adminapiind.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
利雅得：adminapiksa.im.qcloud.com
v4/im_msg_db_logic/admin_set_do_not_disturb
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为 json。

最高调用频率

200次/秒。

请求包示例一

账号 user1 在每天的12:00~18:00时间段(北京时间)内，免打扰选项是屏蔽（在线不推，离线也不推）。其他时间段免打扰选项是接收并提示。
{
   "To_Account": "user1",
   "StartTime": 1747713600, //2025-05-20 12:00:00
   "EndTime": 1747735200,   //2025-05-20 18:00:00
   "IsRepeated": 1,
   "Level": 1
}

请求包示例二

账号 user1 仅在2025-05-20的12:00~18:00时间段内，免打扰选项是屏蔽（在线不推，离线也不推）。其他时间段免打扰选项是接收并提示。
{
   "To_Account": "user1",
   "StartTime": 1747713600, //2025-05-20 12:00:00
   "EndTime": 1747735200,   //2025-05-20 18:00:00
   "IsRepeated": 1,
   "Level": 0
}

应答包体示例

{
    "ErrorCode": 0,
    "ErrorInfo": "succeed",
    "ActionStatus": "OK"
}

请求包字段说明

字段
类型
属性
说明
To_Account
String
必填
待设置的用户 UserId。
StartTime
Integer
必填
免打扰时间段的起始 unix 时间戳。
EndTime
Integer
必填
免打扰时间段的结束 unix 时间戳。
IsRepeated
Integer
必填
是否重复生效，0：一次性 1：重复生效。只能是这两种之一。
Level
Integer
必填
全局免打扰选项：
0：接收并提示 。
1：屏蔽（在线不推，离线也不推）。
2：接收不提示（没有离线推送）。
只能是这三种之一。

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败。
ErrorCode
Integer
错误码，0表示成功，非0表示失败。
ErrorInfo
String
错误信息。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
72011
没有在控制台 开启全局免打扰功能。
90001
JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90003
JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 账号不存在。
90008
JSON 格式请求包体中缺少 From_Account 字段或者 From_Account 账号不存在。

参考

单发单聊消息（v4/openim/sendmsg）
批量发单聊消息（v4/openim/batchsendmsg）
查询单聊消息（v4/openim/admin_getroammsg）
撤回单聊消息（v4/openim/admin_msgwithdraw）

中国站