背景说明
全局禁言包括单聊消息全局禁言和群组消息全局禁言。
账号默认未设置单聊消息全局禁言;如果账号被设置单聊消息全局禁言,在单聊消息禁言时间未到期时间内所有的单聊消息发送失败,到期后即时通信 IM 后台自动解除单聊消息禁言,解除后所有单聊消息就能发送正常;对于永久全局单聊禁言,全局单聊消息禁言时间一直不过期。
账号默认未设置群组消息全局禁言。如果账号被设置群组消息全局禁言,在群组消息禁言时间内所有的群组消息发送失败,到期后即时通信 IM 后台自动解除群组消息禁言,解除后所有群组消息就能发送正常;对于永久全局群组消息禁言,全局群组消息禁言时间一直不过期。
功能说明
查询账号的单聊消息全局禁言。
查询账号的群组消息全局禁言。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/openconfigsvr/getnospeaking?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com 首尔: adminapikr.im.qcloud.com 法兰克福: adminapiger.im.qcloud.com 硅谷: adminapiusa.im.qcloud.com 雅加达: adminapiidn.im.qcloud.com |
v4/openconfigsvr/getnospeaking | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
{"Get_Account": "lumotuwe"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
Get_Account | String | 必填 | 查询禁言信息的账号 |
应答包体示例
{"ErrorCode": 0,"ErrorInfo": "","C2CmsgNospeakingTime": 4294967295,"GroupmsgNospeakingTime": 7196}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 请求错误码: 0:表示成功 非0:表示失败 |
ErrorInfo | String | 错误相关信息 |
C2CmsgNospeakingTime | Number | 单聊消息禁言时长,单位为秒,非负整数。等于 0 代表没有被设置禁言;等于最大值4294967295(十六进制 0xFFFFFFFF)代表被设置永久禁言;其它代表该账号禁言时长,如果等于3600表示该账号被禁言一小时 |
GroupmsgNospeakingTime | Number | 群组消息禁言时长,单位为秒,非负整数。等于0代表没有被设置禁言;等于最大值4294967295(十六进制 0xFFFFFFFF)代表被设置永久禁言;其它代表该账号禁言时长,如果等于3600表示该账号被禁言一小时 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200;真正的错误码、错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
130001 | JSON 格式解析失败,请检查请求包是否符合 JSON 规范 |
130002 | JSON 格式请求包中没有 Get_Account 字段 |
130003 | JSON 格式请求包中的 Get_Account 字段无效 |
130014 | JSON 系统错误,请再次尝试或联系技术客服 |