有奖:语音产品征文挑战赛火热进行中> HOT

背景说明

全局禁言包括单聊消息全局禁言和群组消息全局禁言。
如果账号被设置单聊消息全局禁言,在单聊消息禁言时间未到期时间内,所有的单聊消息发送失败,发送者接收到错误码20012(详见 错误码),不会触发 发单聊消息之前回调;禁言时间到期后即时通信 IM 后台自动解除单聊消息禁言,解除后所有单聊消息就能发送正常;对于永久单聊消息全局禁言,全局单聊消息禁言时间一直不过期;账号默认未设置单聊消息全局禁言。
如果账号被设置群组消息全局禁言,在群组消息禁言时间内所有的群组消息发送失败,发送者接收到错误码10017(详见 错误码),不会触发 群内发言之前回调;禁言时间到期后即时通信 IM 后台自动解除群组消息禁言,解除后所有群组消息就能发送正常;对于永久群组消息全局禁言,全局群组消息禁言时间一直不过期。账号默认未设置群组消息全局禁言。

功能说明

设置账号的单聊消息全局禁言。
设置账号的群组消息全局禁言。

接口调用说明

请求 URL示例

https://xxxxxx/v4/openconfigsvr/setnospeaking?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
法兰克福:adminapiger.im.qcloud.com
孟买:adminapiind.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/openconfigsvr/setnospeaking
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"Set_Account": "lumotuwe",
"C2CmsgNospeakingTime": 4294967295, // C2CmsgNospeakingTime 和 GroupmsgNospeakingTime 是选填字段,但不能两个都不填
"GroupmsgNospeakingTime": 7200
}

请求包字段说明

字段
类型
属性
说明
Set_Account
String
必填
设置禁言配置的账号
C2CmsgNospeakingTime
Integer
选填
单聊消息禁言时间,单位为秒,非负整数,最大值为4294967295(十六进制 0xFFFFFFFF)
0表示取消该账号的单聊消息禁言
4294967295表示该账号被设置永久禁言
其它值表示该账号具体的禁言时间
GroupmsgNospeakingTime
Integer
选填
群组消息禁言时间,单位为秒,非负整数,最大值为4294967295(十六进制 0xFFFFFFFF)
0表示取消该账号的群组消息禁言
4294967295表示该账号被设置永久禁言
其它值表示该账号的具体禁言时间

应答包体示例

{
"ErrorCode": 0,
"ErrorInfo": "",
}

应答包字段说明

字段
类型
说明
ErrorCode
Integer
请求错误码:
0:表示成功
非0:表示失败
ErrorInfo
String
错误相关信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200;真正的错误码、错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示。 公共错误码(60000到79999)详见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
130001
JSON 格式解析失败,请检查请求包是否符合 JSON 规范
130004
JSON 格式请求包中没有 Set_Account 字段
130005
JSON 格式请求包中的 Set_Account 字段无效
130008
JSON 格式请求包中 GroupmsgNospeakingTime 和 C2CmsgNospeakingTime 这两个字段都没有填写
130014
系统错误,请再次尝试或联系技术客服

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

查询全局禁言(v4/openconfigsvr/setnospeaking