查询 app 下的所有全局禁言的用户

功能说明

分页查询 app 下所有全局禁言的用户及其禁言剩余时间。

开通功能

使用用户全局禁言功能前，你需在环信控制台开通。详见 环信控制台文档。

调用频率上限

100 次/秒/App Key

请求 URL

GET https://{host}/{org_name}/{app_name}/mutes?pageNum={N}&pageSize={N}

参数	类型	是否必需	描述
pageNum	Int	否	请求查询的页码。
pageSize	Int	否	请求查询每页显示的禁言用户的数量。取值范围为 [1,50]。

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

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X GET 'https://XXXX/XXXX/XXXX/mutes?pageNum=1&pageSize=10' \
-H 'Authorization: Bearer <YourAppToken>' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'  \

请求 header 参数

关于 Content-Type、Accept 和 Authorization 字段的说明，详见 请求 header 参数说明。

请求 body 参数

响应示例

{
  "path": "/mutes",
  "uri": "https://XXXX/XXXX/XXXX/mutes",
  "timestamp": 1631609858771,
  "organization": "XXXX",
  "application": "357169f0-XXXX-XXXX-9b3a-f1af649cc48d",
  "action": "get",
  "data": {
    "data": [
      {
        "username": "zs2",
        "chatroom": 0
      },
      {
        "username": "zs1",
        "groupchat": 69
      },
      {
        "username": "zs1",
        "chat": 69
      },
      {
        "username": "zs1",
        "chatroom": 69
      },
      {
        "username": "h2",
        "chatroom": 0
      },
      {
        "username": "h2",
        "groupchat": 0
      },
      {
        "username": "h2",
        "chat": 0
      }
    ],
    "unixtime": 1631609858
  },
  "duration": 17,
  "applicationName": "XXXX"
}

响应 body 字段

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

字段	类型	描述
data	JSON Array	获取的所有全局禁言的用户的信息。
- username	String	设置禁言的用户 ID。
- chat	Int	单聊剩余禁言时间，单位为秒。最大值为 2147483647。 - > 0：该用户 ID 具体的单聊禁言时长。 - 0：该用户的单聊禁言已取消。 - -1：该用户被设置永久单聊禁言。
- groupchat	Int	群组剩余禁言时长，单位为秒，规则同单聊禁言。
- chatroom	Int	聊天室剩余禁言时长，单位为秒，规则同单聊禁言。
- unixtime	Long	当前操作的 Unix 时间戳，单位为毫秒。

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

字段	类型	描述
path	String	请求路径，属于请求 URL 的一部分，开发者无需关注。
uri	String	请求 URL。
timestamp	Long	Unix 时间戳，单位为毫秒。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
application	String	应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。
action	String	请求方法。
duration	Int	从发送请求到响应的时长，单位为毫秒。
applicationName	String	你在环信控制台创建应用时填入的应用名称，与请求参数 app_name 相同。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 错误码 了解可能的原因。

错误码

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

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	organization_application_not_found	Could not find application for XXX/XXX from URI: XXX/XXX/users	App key 不存在。	检查 orgName 和 appName 是否正确或 创建应用。

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