获取禁言列表

功能说明

获取当前聊天室的禁言用户列表。

调用频率上限

100 次/秒/App ID

请求 URL

GET https://{host}/app-id/{app_id}/chatrooms/{chatroom_id}/mute

参数	类型	是否必需	描述
chatroom_id	String	是	聊天室 ID。

关于请求 URL 中的其他参数说明，详见 请求 URL 参数介绍。

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET https://XXXX/app-id/{app_id}/chatrooms/12XXXX11/mute   \
-H 'Authorization: Bearer <YourAppToken>'

请求 header 参数

关于 Authorization 字段的说明，详见 请求 header 参数说明。

响应示例

{
  "action": "get",
  "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/mute",
  "entities": [],
  "data": [
    {
      "expire": 1489158589481,
      "user": "user1"
    },
    {
      "expire": 1489158589481,
      "user": "user2"
    }
  ],
  "timestamp": 1489072802179,
  "duration": 0
}

响应 body 字段

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中的 data 字段如下所示：

字段	类型	描述
data	JSON Array	响应数据。
- expire	Long	禁言到期的 Unix 时间戳，单位为毫秒。
- user	String	被禁言的用户 ID。

响应体中的其他参数说明如下表所示：

参数	类型	描述
action	String	请求方法。
uri	String	请求 URL。
entities	JSON Array	响应实体。
timestamp	Long	Unix 时间戳，单位为毫秒。
duration	Int	从发送请求到响应的时长，单位为毫秒。

错误码

如果返回的 HTTP 状态码非 200，表示请求失败，可能提示以下错误码：

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	resource_not_found	grpID XX does not exist!	聊天室不存在。	使用合法的聊天室 ID。

关于其他错误，你可以参考 响应状态码 了解可能的原因。