AI绘画有奖征文大赛:火热进行中> HOT

功能说明

App 管理员禁止指定群组中某些用户在一段时间内发言。
App 管理员取消对某些用户的禁言。
被禁言用户退出群组之后再进入同一群组,禁言仍然有效。

接口调用说明

适用的群组类型

群组类型
支持此 REST API
Private
不支持,同新版本中的 Work(好友工作群)
Public
支持
ChatRoom
支持,同新版本中的 Meeting(会议群)
AVChatRoom
支持
Community(社群)
支持
即时通信 IM 内置以上四种群组类型,详情请参阅 群组系统
说明
Private(即新版本中的 Work,好友工作群)类型不支持禁言。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/forbid_send_msg?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
v4/group_open_http_svc/forbid_send_msg
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

设置禁言 可以通过 MuteTime 设置禁言时间,对指定用户禁言。
{
"GroupId": "@TGS#2C5SZEAEF",
"Members_Account": [ // 最多支持500个
"peter",
"leckie"
],
"MuteTime": 60 // 禁言时间,单位为秒
}
取消禁言 如果要取消禁言,将 MuteTime 设为0。
{
"GroupId": "@TGS#2C5SZEAEF",
"Members_Account": [ // 最多支持 500
"peter",
"leckie"
],
"MuteTime": 0 // 为0时表示取消禁言
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
需要查询的群组 ID
Members_Account
Array
必填
需要禁言的用户账号,最多支持500个账号
MuteTime
Integer
必填
无符号类型。需禁言时间,单位为秒,为0时表示取消禁言,4294967295为永久禁言。
TopicId
String
选填
话题的 ID,若具有此选项表示需要设置的是用户所在话题的禁言状态,仅支持话题的社群适用此选项

应答包体示例

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

应答包字段说明

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

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
描述
10002
服务器内部错误,请重试
10003
请求命令字非法
10004
参数非法,请根据错误描述检查请求是否正确
10007
操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限
10010
群组不存在,或者曾经存在过,但是目前已经被解散
10015
群组 ID 非法,请检查群组 ID 是否填写正确

接口调试工具

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

参考

获取被禁言群成员列表(v4/group_open_http_svc/get_group_muted_account