功能说明
App 管理员可以根据群组 ID 获取群组中被禁言的用户列表。
接口调用说明
适用的群组类型
群组类型ID | 支持此 REST API |
Private | 支持，同新版本中的 Work（好友工作群） |
Public | 支持 |
ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
AVChatRoom | 支持 |
Community（社群） | 支持 |
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/get_group_muted_account?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/group_open_http_svc/get_group_muted_account | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
用来获取群组中被禁言的成员列表，只包含群 ID。
{"GroupId":"@TGS#1KGZ2RAEU"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 需要获取被禁言成员列表的群组 ID。 |
TopicId | String | 选填 | 话题的 ID，若具有此选项表示需要获取的是话题中被禁言的群成员列表，仅支持话题的社群适用此选项。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"GroupId": "@TGS#2FZNNRAEU","MutedAccountList": [ // 群组中被禁言的用户列表{"Member_Account": "tommy", // 用户 ID"MutedUntil": 1458115189 // 禁言到的时间（使用 UTC 时间，即世界协调时间）},{"Member_Account": "peter","MutedUntil": 1458115189}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功 FAIL：表示失败 |
ErrorCode | Integer | 错误码： 0：表示成功 非0：表示失败 |
ErrorInfo | String | 错误信息 |
MutedAccountList | Array | 返回结果为禁言用户信息数组，内容包括被禁言的成员 ID，及其被禁言到的时间（使用 UTC 时间，即世界协调时间） |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 描述 |
10002 | 服务器内部错误，请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法，请根据错误描述检查请求是否正确 |
10007 | 操作权限不足，例如 Public 群组中普通成员尝试执行踢人操作，但只有 App 管理员才有权限 |
10010 | 群组不存在，或者曾经存在过，但是目前已经被解散 |
10015 | 群组 ID 非法，请检查群组 ID 是否填写正确 |
