批量踢出子区成员

功能说明

• 批量踢出子区成员。
• 每次最多可踢出 10 个子区成员。
• 使用该接口前，你需要在 环信控制台 开通子区功能。

调用频率上限

100 次/秒/App Key

请求 URL

DELETE https://{host}/{org_name}/{app_name}/thread/{thread_id}/users

参数	类型	是否必需	描述
thread_id	String	是	子区 ID。

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

请求示例

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

curl -X DELETE https://XXXX/XXXX/XXXX/thread/1XXXX7/users \
-H 'Authorization: Bearer <YourAppToken>' \
-d '{
      "usernames": [
        "test2",
        "test3"
      ]
    }'

请求 header 参数

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

请求 body 参数

参数	类型	是否必需	备注
usernames	List	是	批量踢出子区的用户 ID 列表。每次最多可踢出 10 个子区成员。

响应示例

{
  "action": "delete",
  "applicationName": "testy",
  "duration": 12412,
  "entities": [
    {
      "result": false,
      "user": "test2"
    },
    {
      "result": false,
      "user": "test6"
    }
  ],
  "organization": "XXXX",
  "timestamp": 1650874050419,
  "uri": "https://XXXX/XXXX/XXXX/thread/1XXXX8/users"
}

响应 body 字段

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

字段	类型	描述
entities	JSON Array	响应数据。
- result	Bool	操作结果。 - true：成功； - false：失败。
- user	String	被踢出子区的用户 ID。

其他字段的说明如下：

字段	类型	描述
action	String	请求方法。
applicationName	String	你在环信控制台创建应用时填入的应用名称，与请求参数 app_name 相同。
duration	Int	从发送请求到响应的时长，单位为毫秒。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
timestamp	Long	Unix 时间戳，单位为毫秒。
uri	String	请求 URL。

错误码

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

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
400	group_error	request body reaches limit.	请求 body 中的 usernames 参数的值已超过上限。	请检查请求 body 中的 usernames 参数的值是否超过了 10。每次最多可踢出 10 个子区成员。
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	group_error	thread not found.	子区不存在	输入正确的子区 ID。
403	group_error	thread not open.	子区功能未开通。	请在环信控制台开通子区服务。

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