文档中心

本文介绍聊天室管理相关接口，包括添加、获取、修改和删改聊天室以及聊天室成员管理相关操作。

#前提条件

要调用环信即时通讯 RESTful API，请确保满足以下要求：

• 已在环信即时通讯控制台 开通配置环信即时通讯 IM 服务。
• 了解环信 IM REST API 的调用频率限制，详见接口频率限制。

#聊天室成员角色

#公共参数

#请求参数

#响应参数

#认证方式

环信即时通讯 REST API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，都必须在请求头部填入如下 Authorization 字段：

Authorization: Bearer YourAppToken

为提高项目的安全性，环信使用 token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 REST API 推荐使用 app token 的鉴权方式，详见 使用 App Token 鉴权。

#管理超级管理员

在即时通讯应用中，仅聊天室超级管理员具有在客户端创建聊天室的权限。

环信即时通讯 IM 提供多个管理超级管理员的接口，包括获取、添加、移除等操作。

#添加超级管理员

添加一个聊天室超级管理员。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/super_admin

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST 'https://XXXX/XXXX/XXXX//chatrooms/super_admin'

 -H 'Authorization: Bearer <YourAppToken>' -H 'Content-Type: application/json' -d '{
    "superadmin": "user1"
}' 

#响应示例

{ "action": "post", "application": "09XXXX34", "applicationName": "XXXX", "data": { "result": "success", "

resource": "" }, "duration": 1, "entities": [], "organization": "XXXX", "timestamp": 1656488117703, "uri":

 "https://XXXX/XXXX/XXXX/chatrooms/super_admin" } 

#分页获取超级管理员列表

可以分页获取超级管理员列表的接口。

#HTTP 请求

直接获取：

GET https://{host}/{org_name}/{app_name}/chatrooms/super_admin

分页获取：

GET https://{host}/{org_name}/{app_name}/chatrooms/super_admin?pagenum={N}&pagesize={N}

#路径参数

参数及描述详见 公共参数。

#查询参数

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET https://XXXX/XXXX/XXXX/chatrooms/super_a

dmin?pagenum=2&pagesize=2 -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "get", "application": "9fXXXX04", "params": { "pagesize": ["2"], "pagenum": ["2"] }, "uri": 

"https://XXXX/XXXX/XXXX/chatrooms/super_admin", "entities": [], "data": ["hXXXX1", "hXXXX11", "hXXXX10"], 

"timestamp": 1596187292391, "duration": 0, "organization": "XXXX", "applicationName": "testapp", "count": 3 } 

#撤销超级管理员

撤销超级管理员权限，用户将不能再创建聊天室。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}

#路径参数

其他参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl --location --request DELETE 'https://XXXX/XX

XX/XXXX/chatrooms/super_admin/XXXX' --header 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "delete", "application": "09XXXX34", "applicationName": "XXXX", "data": { "newSuperAdmin":

 "XXXX", "resource": "" }, "duration": 0, "entities": [], "organization": "XXXX", "properties": {}, 

"timestamp": 1656488154100, "uri": "https://XXXX/XXXX/XXXX/chatrooms/super_admin/XXXX" } 

#管理聊天室

环信即时通讯 IM 提供多个接口实现聊天室管理，包括对聊天室的创建、获取、修改、移除等管理功能。

#获取 app 中的聊天室

分页获取应用下的聊天室列表和信息。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms?limit={N}&cursor={cursor}

#路径参数

参数及描述详见 公共参数。

#查询参数

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl --location --request GET 'https://XXX

X/XXXX/XXXX/chatrooms?limit=10' \ --header 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "data": { "id": "662XXXX13", "name": "testchatroom1", "owner": "user1", "affiliations_count": 2 } } 

#获取用户加入的聊天室

根据用户 ID 获取该用户加入的全部聊天室。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/users/{username}/joined_chatrooms

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET -H 'Accept: application/json' -H '

Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/users/user1/joined_chatrooms' 

#响应示例

{ "data": { "id": "662XXXX13", "name": "testchatroom1" } } 

#查询聊天室详情

查询一个或多个聊天室的详情。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}

#路径参数

其他参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET -H 'Accept: application/json' -H '

Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/662XXXX13' 

#响应示例

{ "data": { "id": "662XXXX13", "name": "testchatroom1", "description": "test", "membersonly": false,

 "allowinvites": false, "maxusers": 200, "owner": "user1", "created": 1542542951527, "custom": "",

 "affiliations_count": 2, "affiliations": [ { "member": "user2" }, { "owner": "user1" } ], "public": true } } 

#创建聊天室

创建一个聊天室，需设置聊天室名称、聊天室描述、聊天室成员最大人数（包括管理员）、聊天室管理员和普通成员以及聊天室扩展信息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' 

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
   "name": "testchatroom1",
   "description": "test",
   "maxusers": 300,
   "owner": "user1",
   "members": [
     "user2"
   ]
 }' 'https://XXXX/XXXX/XXXX/chatrooms' 

#响应示例

{ "data": { "id": "66XXXX33" } } 

#修改聊天室信息

修改指定聊天室的信息。仅支持修改聊天室名称、聊天室描述和聊天室最大成员数。

#HTTP 请求

PUT https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

你只能修改聊天室名称、聊天室描述和聊天室最大成员数。

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X PUT -H 'Content-Type: application/json' 

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
   "name": "testchatroom",
   "description": "test",
   "maxusers": 300
 }' 'https://XXXX/XXXX/XXXX/chatrooms/662XXXX13' 

#响应示例

{ "data": { "description": true, "maxusers": true, "groupname": true } } 

#删除聊天室

删除单个聊天室。如果要删除的聊天室不存在，会返回错误。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

参数及描述详见 公共参数。

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Accept: application/json' 

-H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/662XXXX13' 

#响应示例

{ "action": "delete", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/662XXXX13",

 "entities": [], "data": { "success": true, "id": "662XXXX13" }, "timestamp": 1542545100474, "duration":

 0, "organization": "XXXX", "applicationName": "testapp" } 

#获取聊天室公告

获取指定聊天室 ID 的聊天室公告。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

在返回值中查看 data 字段包含的信息，获取到的聊天室公告信息。

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET -H 'Content-Type: application/json'

 -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 

'https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announcement' 

#响应示例

{ "action": "get", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announcem

ent", "entities": [], "data": { "announcement": "XXXX." }, "timestamp": 1542363546590, "duration": 0,

 "organization": "XXXX", "applicationName": "testapp" } 

#修改聊天室公告

修改指定聊天室 ID 的聊天室公告。聊天室公告内容不能超过 512 个字符。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' 

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatro

oms/12XXXX11/announcement' -d '{"announcement" : "聊天室公告…"}' 

#响应示例

{ "action": "post", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/announce

ment", "entities": [], "data": { "id": "12XXXX11", "result": true }, "timestamp": 1594808604236, "durati

on": 0, "organization": "XXXX", "applicationName": "testapp" } 

#设置聊天室自定义属性

指定用户设置特定聊天室的自定义属性。

#HTTP 请求

PUT https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X PUT -H 'Content-Type: application/json' -H 'Acc

ept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
    "metaData": {
  			"key1": "value1",
				"key2": "value2"
    },
    "autoDelete": "DELETE"
 }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1' 

#响应示例

{ "data": { "successKeys": ["key1"], "errorKeys": { "key2": "errorDesc" } } } 

#获取聊天室自定义属性

获取指定聊天室的自定义属性信息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' -H 

'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
    "keys": ["key1","key2"]
 }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13' 

#响应示例

{ "data": { "key1": "value1", "key2": "value2" } } 

#删除聊天室自定义属性

用户删除其设置的聊天室自定义属性。该方法只能删除当前用户设置的聊天室自定义属性，不能删除其他成员设置的自定义属性。

该方法每次最多可删除 10 个自定义属性。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token DELETE -X POST -H 'Content-Type: application/json' 

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
    "keys": ["key1","key2"]
 }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1' 

#响应示例

{ "data": { "successKeys": ["key1"], "errorKeys": { "key2": "errorDesc" } } } 

#强制设置聊天室自定义属性

用户强制设置指定聊天室的自定义属性信息，即该方法可覆盖其他用户设置的聊天室自定义属性。

#HTTP 请求

PUT https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}/forced

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X PUT -H 'Content-Type: application/json'

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
    "metaData": {
        "key1": "value1",
		"key2": "value2"
    },
    "autoDelete": "DELETE"
 }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1/forced' 

#响应示例

{ "data": { "successKeys": ["key1"], "errorKeys": { "key2": "errorDesc" } } } 

#强制删除聊天室自定义属性

用户强制删除聊天室的自定义属性信息，即该方法除了会删除当前用户设置的聊天室自定义属性，还可以删除其他用户设置的自定义属性。

该方法每次最多可删除 10 个自定义属性。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}/forced

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token DELETE -X POST -H 'Content-Type: application/json' 

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
    "keys": ["key1","key2"]
 }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1/forced' 

#响应示例

{ "data": { "successKeys": ["key1"], "errorKeys": { "key2": "errorDesc" } } } 

#管理聊天室成员

环信即时通讯 IM 提供多个接口实现聊天室成员管理，包括添加和移除聊天室成员、转让聊天室所有权以及聊天室黑名单、白名单和禁言列表相关操作。

#分页获取聊天室成员

可以分页获取聊天室成员列表。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users?pagenum={N}&pagesize={N}

#路径参数

参数及描述详见 公共参数。

#查询参数

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET https://XXXX/XXXX/XXXX/chatrooms/12XX

XX11/users?pagenum=2&pagesize=2 -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "get", "application": "52XXXXf0", "params": { "pagesize": ["2"], "pagenum": ["2"] }, "uri": 

"https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/users", "entities": [], "data": [ { "member": "user1" }, 

{ "member": "user2" } ], "timestamp": 1489074511416, "duration": 0, "organization": "XXXX", 

"applicationName": "testapp", "count": 2 } 

#添加单个聊天室成员

向聊天室添加一个成员。如果待添加的用户在 app 中不存在或已经在聊天室中，则请求失败并返回错误码 400。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' -H '

Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users/user1' 

#响应示例

{ "action": "post", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/us

ers/user1", "entities": [], "data": { "result": true, "action": "add_member", "id": "66XXXX33", "user":

 "user1" }, "timestamp": 1542554038353, "duration": 0, "organization": "XXXX", "applicationName": "testapp" } 

#批量添加聊天室成员

向聊天室添加多位用户，一次性最多可添加 60 位用户。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' -H '

Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
   "usernames": [
     "user1","user2"
   ]
 }' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users' 

#响应示例

{ "action": "post", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users", 

"entities": [], "data": { "newmembers": ["user1", "user2"], "action": "add_member", "id": "66XXXX33" }, 

"timestamp": 1542554537237, "duration": 9, "organization": "XXXX", "applicationName": "testapp" } 

#移除单个聊天室成员

从聊天室移除一个成员。如果被移除用户不在聊天室中或聊天室不存在，将返回错误。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Accept: application/json' -H '

Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users/user1' 

#响应示例

{ "action": "delete", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users

/user1", "entities": [], "data": { "result": true, "action": "remove_member", "user": "user1", "id": 

"66XXXX33" }, "timestamp": 1542555744726, "duration": 1, "organization": "XXXX", "applicationName": "testapp" } 

#批量移除聊天室成员

从聊天室移除多个成员，单次请求最多可移除 100 个成员。如果被移除用户不在聊天室中或聊天室不存在，将返回错误。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{usernames}

#路径参数

其他字段及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Accept: application/json' -H '

Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/users/user1%2Cuser2' 

#响应示例

{ "action": "delete", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XX

XX33/users/user1%2Cuser2", "entities": [], "data": [ { "result": false, "action": "remove_member", 

"reason": "user: user1 doesn't exist in group: 66XXXX33", "user": "user1", "id": "66XXXX33" }, 

{ "result": true, "action": "remove_member", "user": "user2", "id": "66XXXX33" } ], "timestamp": 

1542556177147, "duration": 0, "organization": "XXXX", "applicationName": "testapp" } 

#获取聊天室管理员列表

获取聊天室管理员列表的接口。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET https://XXXX/XXXX/XXXX/chatrooms/12

XXXX11/admin -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "get", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/admin",

 "entities": [], "data": ["user1"], "timestamp": 1489073361210, "duration": 0, "organization": "XXXX", 

"applicationName": "testapp", "count": 1 } 

#添加聊天室管理员

将一个聊天室成员设置为聊天室管理员。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST https://XXXX/XXXX/XXXX/chatrooms/

12XXXX11/admin -d '{"newadmin":"user1"}' -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "post", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/admin", 

"entities": [], "data": { "result": "success", "newadmin": "user1" }, "timestamp": 1489073130083, "duration":

 1, "organization": "XXXX", "applicationName": "testapp" } 

#移除聊天室管理员

将用户的角色从聊天室管理员降为普通聊天室成员。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin/{oldadmin}

#路径参数

其他字段及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE https://XXXX/XXXX/XXXX/chatrooms/12XXXX11

/admin/user1 -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "delete", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/admin/user1",

 "entities": [], "data": { "result": "success", "oldadmin": "user1" }, "timestamp": 1489073432732, "duration": 

1, "organization": "XXXX", "applicationName": "testapp" } 

#管理黑名单

环信即时通讯 IM 提供多个接口实现聊天室黑名单管理，包括查看黑名单中的用户以及将用户添加至和移出黑名单等操作。

#查询聊天室黑名单

查询一个聊天室黑名单中的用户列表。黑名单中的用户无法查看或收到该聊天室的信息。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET -H 'Accept: application/json' -H 

'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blocks/users' 

#响应示例

{ "action": "get", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/bl

ocks/users", "entities": [], "data": ["user2", "user3"], "timestamp": 1543466293681, "duration": 0,

 "organization": "XXXX", "applicationName": "testapp", "count": 2 } 

#添加单个用户至聊天室黑名单

将单个用户加入指定聊天室的黑名单。聊天室所有者无法被加入聊天室的黑名单。

用户进入聊天室黑名单后，会收到消息：“You are kicked out of the chatroom xxx”。之后，该用户无法查看和收发该聊天室的信息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' 

-H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 

'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blocks/users/user1' 

#响应示例

{ "action": "post", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/

blocks/users/user1", "entities": [], "data": { "result": true, "action": "add_blocks", "user": "user1", 

"chatroomid": "66XXXX33" }, "timestamp": 1542539577124, "duration": 27, "organization": "XXXX", "

applicationName": "testapp" } 

#批量添加用户至聊天室黑名单

将多个用户加入指定聊天室的黑名单。你一次最多可以添加 60 个用户至聊天室黑名单。聊天室所有者无法被加入聊天室的黑名单。

用户进入聊天室黑名单后，会收到消息：“You are kicked out of the chatroom xxx”。之后，这些用户无法查看和收发该聊天室的信息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' -H

 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
   "usernames": [
     "user3","user4"
 }' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blocks/users' 

#响应示例

{ "action": "post", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blocks

/users", "entities": [], "data": [ { "result": false, "action": "add_blocks", "reason": "user: user3 doesn'

t exist in chatroom: 66XXXX33", "user": "user3", "chatroomid": "66XXXX33" }, { "result": true, "action": "

add_blocks", "user": "user4", "chatroomid": "66XXXX33" } ], "timestamp": 1542540095540, "duration": 16, 

"organization": "XXXX", "applicationName": "testapp" } 

#从聊天室黑名单移出单个用户

将指定用户移出聊天室黑名单。对于聊天室黑名单中的用户，如果需要将其再次加入聊天室，需要先将其从聊天室黑名单中移除。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Accept: application/json' -

H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blocks/users/user1' 

#响应示例

{ "action": "delete", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66

XXXX33/blocks/users/user1", "entities": [], "data": { "result": true, "action": "remove_blocks", 

"user": "user1", "chatroomid": "66XXXX33" }, "timestamp": 1542540470679, "duration": 45, "organization

": "XXXX", "applicationName": "testapp" } 

#从聊天室黑名单批量移除用户

将多名指定用户从聊天室黑名单中移除。你每次最多可移除 60 个用户。对于聊天室黑名单中的用户，如果需要将其再次加入聊天室，需要先将其从聊天室黑名单中移除。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{usernames}

#路径参数

其他字段及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Accept: application/json' -H 

'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blocks/users/user1%2Cuser2' 

#响应示例

{ "action": "delete", "application": "8beXXXX02", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/blo

cks/users/user1%2Cuser2", "entities": [], "data": [ { "result": true, "action": "remove_blocks", "user": "

user1", "chatroomid": "66XXXX33" }, { "result": true, "action": "remove_blocks", "user": "user2", "chatroomid"

: "66XXXX33" } ], "timestamp": 1542541014655, "duration": 29, "organization": "XXXX", "applicationName": "testapp" } 

#管理白名单

环信即时通讯 IM 提供多个接口实现聊天室白名单管理，包括查看白名单中的用户以及将用户添加至和移出白名单等。

聊天室白名单中的成员在聊天室中发送的消息为高优先级，会优先送达，但不保证必达。当负载较高时，服务器会优先丢弃低优先级的消息。若即便如此负载仍很高，服务器也会丢弃高优先级消息。

#查询聊天室白名单

查询一个聊天室白名单中的用户列表。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET -H 'Accept: application/json' -H '

Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/white/users' 

#响应示例

{ "action": "get", "application": "5cXXXX75d", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/w

hite/users", "entities": [], "data": ["wzy_test", "wzy_vivo", "wzy_huawei", "wzy_xiaomi", "wzy_meizu"], 

"timestamp": 1594724947117, "duration": 3, "organization": "XXXX", "applicationName": "testapp", "count": 5 } 

#添加单个用户至聊天室白名单

将单个用户添加至聊天室白名单。用户添加至聊天室白名单后，当聊天室全员禁言时，仍可以在聊天室中发送消息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Accept: application/json' -H 'Autho

rization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/{66XXXX33}/white/users/{username}' 

#响应示例

{ "action": "post", "application": "5cXXXX75d", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/white/

users/wzy_xiaomi", "entities": [], "data": { "result": true, "action": "add_user_whitelist", "user":

 "wzy_xiaomi", "chatroomid": "66XXXX33" }, "timestamp": 1594724293063, "duration": 4, "organization": 

"XXXX", "applicationName": "testapp" } 

#批量添加用户至聊天室白名单

添加多个用户至聊天室白名单。你一次最多可添加 60 个用户。用户添加至聊天室白名单后，在聊天室全员禁言时，仍可以在聊天室中发送消息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

其他字段及描述详见 公共参数。

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json'

 -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{"usernames" : ["user1"]}' 

'https://XXXX/XXXX/XXXX/chatrooms/{chatroomid}/white/users' 

#响应示例

{ "action": "post", "application": "5cXXXX75d", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/

white/users", "entities": [], "data": [ { "result": true, "action": "add_user_whitelist", "user": 

"wzy_test", "chatroomid": "66XXXX33" }, { "result": true, "action": "add_user_whitelist", "user": 

"wzy_meizu", "chatroomid": "66XXXX33" } ], "timestamp": 1594724634191, "duration": 2, "organization"

: "XXXX", "applicationName": "testapp" } 

#将用户移出聊天室白名单

将指定用户从聊天室白名单移除。你每次最多可移除 60 个用户。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Accept: application/json' -H '

Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/{66XXXX33}/white/users/{username}' 

#响应示例

{ "action": "delete", "application": "5cXXXX75d", "uri": "https://XXXX/XXXX/XXXX/chatrooms/66XXXX33/white/u

sers/wzy_huawei,wzy_meizu", "entities": [], "data": [ { "result": true, "action": "remove_user_whitelist", 

"user": "wzy_huawei", "chatroomid": "66XXXX33" }, { "result": true, "action": "remove_user_whitelist", "user":

 "wzy_meizu", "chatroomid": "66XXXX33" } ], "timestamp": 1594725137704, "duration": 1, "organization":

 "XXXX", "applicationName": "XXXX" } 

#管理禁言

环信即时通讯 IM 提供多个管理聊天室禁言列表的接口，包括获取禁言列表以及将用户添加至或移出禁言列表等。

#获取禁言列表

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

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X GET HTTP://XXXX/XXXX/XXXX/chatrooms/12XXXX11/mute

 -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "get", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/mute",

 "entities": [], "data": [ { "expire": 1489158589481, "user": "user1" }, { "expire": 1489158589481, 

"user": "user2" } ], "timestamp": 1489072802179, "duration": 0, "organization": "XXXX", "applicationName": "testapp" } 

#禁言聊天室成员

禁言单个用户。用户被禁言后，将无法在聊天室中发送消息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute

#路径参数

参数及描述详见 公共参数。

#请求 header

#请求 body

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json'

 -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
    "usernames": [
        "user1",
        "user2"
    ],
    "mute_duration": 86400000
}'https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/mute'

#响应示例

{ "action": "post", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/mute", "

entities": [], "data": [ { "result": true, "expire": 1642148173726, "user": "user1" }, { "result": true, 

"expire": 1642148173726, "user": "user2" } ], "timestamp": 1489072189508, "duration": 0, "organization":

 "XXXX", "applicationName": "testapp" } 

#禁言聊天室全体成员

对所有聊天室成员一键禁言。该操作不影响聊天室禁言列表，即一键禁言不会将聊天室所有成员加入聊天室禁言列表。

设置聊天室全员禁言后，仅聊天室白名单中的用户可在聊天室内发消息。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/ban

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X POST -H 'Content-Type: application/json' -H

 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/ban' 

#响应示例

{ "action": "put", "application": "5cXXXX75d", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/ban", "

entities": [], "data": { "mute": true }, "timestamp": 1594628861058, "duration": 1, "organization":

 "XXXX", "applicationName": "testapp" } 

#解除聊天室禁言成员

解除对一个或多个聊天室成员的禁言。解除禁言后，该成员可以正常在聊天室中发送消息。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute/{member1}(,{member2},…)

#路径参数

其他字段及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE HTTP://XXXX/XXXX/XXXX/chatrooms/12

XXXX11/mute/user1 -H 'Authorization: Bearer <YourAppToken>' 

#响应示例

{ "action": "delete", "application": "52XXXXf0", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX1

1/mute/user1", "entities": [], "data": [ { "result": true, "user": "user1" } ], "timestamp": 148907

2695859, "duration": 0, "organization": "XXXX", "applicationName": "testapp" } 

#解除聊天室全员禁言

一键取消对聊天室全体成员的禁言。解除禁言后，聊天室成员可以在聊天室中正常发送消息。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/ban

#路径参数

参数及描述详见 公共参数。

#请求 header

#HTTP 响应

#响应 body

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

其他字段及描述详见 公共参数。

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

#示例

#请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token curl -X DELETE -H 'Content-Type: applicati

on/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/ban' 

#响应示例

{ "action": "delete", "application": "5cXXXX75d", "uri": "https://XXXX/XXXX/XXXX/chatrooms/12XXXX11/ban",

 "entities": [], "data": { "mute": false }, "timestamp": 1594628899502, "duration": 1, "organization": "XXXX", 

"applicationName": "testapp" }