聊天室管理

更新时间:2022-05-18

本文介绍聊天室管理相关接口。调用接口前你需要了解认证方式:使用 app token 鉴权

聊天室数据结构:

名称 类型 描述
id String 聊天室 ID,聊天室唯一标识,由环信即时通讯 IM 服务器生成。
name String 聊天室名称,任意字符串,最大长度为 128 字符。
description String 聊天室描述,任意字符串,最大长度为 512 字符。
maxusers Integer聊天室成员上限,创建聊天室的时候设置,可修改。
affiliations_countInteger现有成员总数。
affiliations Array 现有成员列表,包含了 owner 和 member。例如: “affiliations”:[{“owner”: “13800138001”},{“member”:”v3y0kf9arx”},{“member”:”xc6xrnbzci”}]。
owner String 聊天室所有者的 username。例如:{“owner”: “13800138001”}。
member String 聊天室成员的 username。例如: {“member”:”xc6xrnbzci”}。

以下为常用响应体参数及描述:

参数 描述
action 请求方式,即接口方法名。
host 你在环信即时通讯云控制台注册的 app 对应的集群地址。
organization org_name,即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
application 系统内为应用生成的唯一标识,开发者无需关心。
applicationName app_name,你在环信即时通讯云控制台注册项目时填入的应用名称。
uri 请求 URL。
path 请求路径,属于请求 URL 的一部分,开发者无需关注。
entities 详细信息。
data 实际取到的数据详情。
uuid 系统内为用户或者应用生成的系统内唯一标识,开发者无需关心。
created 用户、群组或聊天室的创建时间,Unix 时间戳,单位为毫秒。
username 用户名。
groupname 群组名。
nickname 用户昵称。
timestamp Unix 时间戳,单位为毫秒。
duration 请求响应时间,单位为毫秒。

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

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

Authorization:Bearer ${YourAppToken}

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

具体接口如下:

环信即时通讯 IM 提供多个接口完成聊天室相关的集成,包括对聊天室的创建、获取、修改、删除等管理功能。

名称 请求 描述
获取 app 中所有的聊天室/{org_name}/{app_name}/chatrooms 获取应用下全部的聊天室信息。
获取用户加入的聊天室 /{org_name}/{app_name}/users/{username}/joined_chatrooms根据用户名称获取此用户加入的全部聊天室。
获取聊天室详情 /{org_name}/{app_name}/chatrooms/{chatroom_id} 根据聊天室 ID 获取此聊天室的详情。
创建一个聊天室 /{org_name}/{app_name}/chatrooms 创建一个新聊天室。
修改聊天室信息 /{org_name}/{app_name}/chatrooms/{chatroom_id} 修改聊天室的部分信息。
删除聊天室 /{org_name}/{app_name}/chatrooms/{chatroom_id} 删除一个聊天室。
获取聊天室公告 {org_name}/{app_name}/chatrooms/{chatroom_id}/announcement 获取指定聊天室 ID 的聊天室公告。
修改聊天室公告 {org_name}/{app_name}/chatrooms/{chatroom_id}/announcement 修改指定聊天室 ID 的聊天室公告。

获取 app 中所有的聊天室

接口描述

获取应用下全部的聊天室信息的接口。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
id String聊天室 ID,聊天室唯一标识,由环信即时通讯 IM 服务器生成。
name String聊天室名称,任意字符串,最大长度为 128 字符。
owner String聊天室创建者的 username。例如:{“owner”: “user1”}。
affiliations_countint 聊天室现有成员总数。

请求示例

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms'

响应示例

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

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

获取用户加入的聊天室

接口描述

根据用户名称获取该用户加入的全部聊天室接口。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/users/{username}/joined_chatrooms

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
username String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
id String聊天室 ID,聊天室唯一标识,由环信即时通讯 IM 服务器生成。
nameString聊天室名称,任意字符串,最大长度为 128 字符。

请求示例

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/users/user1/joined_chatrooms'

响应示例

{
  "data": 
    {
        "id": "66211860774913",
    "name": "testchatroom1"
  }
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

获取聊天室详情

接口描述

可以获取一个或多个聊天室的详情。当获取多个聊天室的详情时,可以直接填写多个 chatroom_id 并用 “,” 隔开,一次调用最多输入 100 个聊天室 ID,会返回所有存在的聊天室的详情,对于不存在的聊天室,response body 内返回 “chatroom id doesn’t exist”。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
id String 聊天室 ID,聊天室唯一标识符,由环信即时通讯 IM 服务器生成。
name String 聊天室名称,任意字符串,最大长度为 128 字符。
description String 聊天室描述,任意字符串,最大长度为 512 字符。
membersonly Boolean加入聊天室是否需要群主或者群管理员审批:
true:是
false:否。
allowinvites Boolean是否允许聊天室成员邀请别人加入此聊天室。 加入聊天室是否需要群主或者群管理员审批:
true:允许聊天室成员邀请人加入此聊天室
false:只有聊天室管理员才可以往聊天室加人。
maxusers int 聊天室成员上限,创建聊天室的时候设置,可修改。
owner String 聊天室所有者的 username。例如:{“owner”: “user1”}。
created long 创建聊天室时间,Unix 时间戳,单位为毫秒。
custom String
affiliations_countint 现有聊天室成员总数。
affiliations Array 现有成员列表,包含了 owner 和 member。例如: “affiliations”:[{“owner”: “user1”},{“member”:”user2”},{“member”:”user3”}]。
public Boolean是否公共聊天室:
true:是
false:否。

请求示例

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66211860774913'

响应示例

{
  "data": 
    {
        "id": "66211860774913",
        "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
    }
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

创建聊天室

接口描述

创建一个聊天室,并设置聊天室名称、聊天室描述、公开聊天室/私有聊天室属性、聊天室成员最大人数(包括管理员)、加入公开聊天室是否需要批准、管理员、以及聊天室成员。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 是否必需说明
name String必需 聊天室名称,任意字符串,最大长度为 128 字符。
descriptionString必需 聊天室描述,最大长度为 512 字符。
maxusers int 非必需 聊天室成员最大数(包括聊天室所有者),值为数值类型。
owner String必需 聊天室的管理员。
members Array 非必需 聊天室成员,此属性为可选的,但是如果加了此项,数组元素至少一个。

响应体

参数 类型 说明
idString所创建的聊天室的 ID。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' -d '{ 
   "name": "testchatroom1",  
   "description": "test",  
   "maxusers": 300,  
   "owner": "user1",  
   "members": [  
     "user2"  
   ]  
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms'

响应示例

{
  "data": 
    {
        "id": "66213271109633"
    }
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

修改聊天室信息

接口描述

修改成功的数据行会返回 true,失败为 false。请求 body 只接收 name、description、maxusers 三个属性。传其他字段,或者不能修改的字段会抛异常。

如果聊天室不存在,会返回错误。

基本信息

方法:PUT

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 是否必需 说明
name String 必需 聊天室名称,修改时值不能包含斜杠(“/”)。
description String 必需 聊天室描述,修改时值不能包含斜杠(“/”)。
maxusers String 必需 聊天室最大成员数(包括聊天室所有者),值为数值类型。

响应体

参数 类型 说明
groupname Boolean聊天室名称,
true:修改成功;
false:修改失败。
descriptionBoolean聊天室描述,
true:修改成功;
false:修改失败。
maxusers Boolean聊天室成员最大数(包括聊天室创建者)
true:修改成功;
false:修改失败。

请求示例

curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' -d '{  
   "name": "testchatroom",  
   "description": "test",  
   "maxusers": 300  
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66211860774913'

响应示例

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

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

删除聊天室

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数类型说明

响应体

响应体常见参数部分见本文开头常见参数说明。

参数 类型 说明
successBoolean聊天室删除操作:
true:删除成功;
false:删除失败。
id String 被删除聊天室的 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66211860774913'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66211860774913",
  "entities": [],
  "data": {
    "success": true,
    "id": "66211860774913"
  },
  "timestamp": 1542545100474,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

获取聊天室公告

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

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

参数 类型 说明
announcement String 聊天室公告内容。

请求示例

curl -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/announcement'

响应示例

{
  "action": "get",
  "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/announcement",
  "entities": [],
  "data": {
    "announcement" : "聊天室公告..."
  },
  "timestamp": 1542363546590,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

修改聊天室公告

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
id String 聊天室 ID。
result Boolean 修改结果:
- true :修改成功;
- false :修改失败。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/announcement'

响应示例

{
  "action": "post",
  "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/announcement",
  "entities": [],
  "data": {
    "id": "1265710621211",
    "result": true
  },
  "timestamp": 1594808604236,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

环信即时通讯 IM 提供多个接口实现对聊天室成员的管理,包括添加、移除聊天室成员关系列表等。

名称 请求 描述
分页获取聊天室成员 /{org_name}/{app_name}/chatrooms/{chatroom_id}/users 分页获取一个聊天室的成员列表。
添加单个聊天室成员 /{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username} 添加用户至聊天室成员列表。
批量添加聊天室成员 /{org_name}/{app_name}/chatrooms/{chatroomid}/users 批量添加用户至聊天室成员列表。
删除单个聊天室成员 /{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username} 从聊天室成员列表中删除用户。
批量删除聊天室成员 /{org_name}/{app_name}/chatrooms/{chatroomid}/users/{usernames}从聊天室成员列表中批量删除用户。
获取聊天室管理员列表/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin 获取聊天室管理员列表。
添加聊天室管理员 /{org_name}/{app_name}/chatrooms/{chatroom_id}/admin 添加用户至聊天室管理员列表。
移除聊天室管理员 /{org_name}/{app_name}/chatrooms/{chatroom_id}/admin/{oldadmin}从聊天室管理员列表中移除用户。

分页获取聊天室成员

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users

分页接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/users?limit={N}&cursor={N}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
limit Int 非必需 每页显示的聊天室成员数量。默认值为 1000。取值范围 [0,1000]。超过 1000 按照 1000 返回。
cursor String 非必需 分页使用,传入游标后便从游标起始的地方进行查询,类似于数据库 limit 1,5 中 1 的作用,可以理解为页码。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

响应体常见参数部分见本文开头常见参数说明。

参数 类型 说明
memberString聊天室成员 ID。

请求示例

curl -X GET http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/users?pagenum=2&pagesize=2 -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "get",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "params": {
        "pagesize": ["2"],
        "pagenum": ["2"]
    },
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/users",
    "entities": [],
    "data": [{
        "member": "user1"
    },
    {
        "member": "user2"
    }],
    "timestamp": 1489074511416,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp",
    "count": 2
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

添加单个聊天室成员

接口描述

一次给聊天室添加一个成员,不能重复添加同一个成员。如果用户已经是聊天室成员,将添加失败,并返回错误。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
username String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

响应体常见参数部分见本文开头常见参数说明。

参数 类型 说明
resultBoolean添加结果:
true:添加成功;
false:添加失败。
actionString 执行的操作,add_member 表示向聊天室添加成员。
id String 聊天室 ID,聊天室唯一标识符,由环信即时通讯 IM 服务器生成。
user String 添加到聊天室的用户。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users/user1'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users/user1",
  "entities": [],
  "data": {
    "result": true,
    "action": "add_member",
    "id": "66213271109633",
    "user": "user1"
  },
  "timestamp": 1542554038353,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

批量添加聊天室成员

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroomid String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 是否必需 描述
usernames Array 必需 添加的用户名称。

响应体

响应体常见参数部分见本文开头常见说明。

参数 类型 说明
newmembersArray 添加的用户名称。
action String添加操作提示。
id String聊天室 ID。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' -d '{  
   "usernames": [  
     "user1","user2"  
   ]  
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users",
  "entities": [],
  "data": {
    "newmembers": [
      "user1",
      "user2"
    ],
    "action": "add_member",
    "id": "66213271109633"
  },
  "timestamp": 1542554537237,
  "duration": 9,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

删除单个聊天室成员

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroomid String 必需 聊天室 ID。
username String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

响应体常见参数部分见本文开头常见参数说明。

参数 类型 说明
resultBoolean删除操作结果:
true:删除成功;
false:删除失败。
actionString 删除操作提示。
user String 用户 ID。
id String 聊天室 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users/user1'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users/user1",
  "entities": [],
  "data": {
    "result": true,
    "action": "remove_member",
    "user": "user1",
    "id": "66213271109633"
  },
  "timestamp": 1542555744726,
  "duration": 1,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

批量删除聊天室成员

接口描述

从聊天室删除多个成员。如果被删除用户不在聊天室中,或者聊天室不存在,将返回错误。

一次最多传 100 个用户 ID。

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroomid}/users/{usernames}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroomid String 必需 聊天室 ID。
username String 必需 一个或多个用户 ID,多个用户 ID 间用 “,” 分隔。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

响应体常见参数部分见本文开头常见参数说明。

参数 类型 说明
resultBoolean删除操作结果:
true:删除成功;
false:删除失败。
actionString 删除操作提示。
reasonString 删除失败原因提示。
user String 用户 ID。
id String 聊天室 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users/user1%2Cuser2'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/users/user1%2Cuser2",
  "entities": [],
  "data": [
    {
      "result": false,
      "action": "remove_member",
      "reason": "user: user1 doesn't exist in group: 66213271109633",
      "user": "user1",
      "id": "66213271109633"
    },
    {
      "result": true,
      "action": "remove_member",
      "user": "user2",
      "id": "66213271109633"
    }
  ],
  "timestamp": 1542556177147,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

获取聊天室管理员列表

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

响应体常见参数部分见本文开头常见参数说明。

参数 类型 说明
dataArray管理员 ID。

请求示例

curl -X GET http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/admin -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "get",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/admin",
    "entities": [],
    "data": ["user1"],
    "timestamp": 1489073361210,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp",
    "count": 1
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

添加聊天室管理员

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

方法:POST

接入点:/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin

需要在请求时对应填写 {chatroom_id} 和需要添加管理员的聊天室 ID。

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体参数

参数 说明
newadmin 要添加为聊天室管理员的成员用户 ID。

响应参数

参数 类型 说明
result Boolean 操作结果:
success:添加成功;
false:添加失败。
newadmin String 添加为聊天室管理员的成员用户 ID。

请求示例

curl -X POST http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/admin -d '{"newadmin":"user1"}' -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "post",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/admin",
    "entities": [],
    "data": {
        "result": "success",
        "newadmin": "user1"
    },
    "timestamp": 1489073130083,
    "duration": 1,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。。
429,503 或者其他 5xx 有可能代表该接口被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

移除聊天室管理员

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin/{oldadmin}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
oldadmin String 必需 被撤销权限的管理员 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
result Boolean撤销权限操作结果:
true:移除成功;
false:移除失败。
oldadminString 被撤销权限的管理员 ID。

请求示例

curl -X DELETE http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/admin/user1 -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "delete",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/admin/user1",
    "entities": [],
    "data": {
        "result": "success",
        "oldadmin": "user1"
    },
    "timestamp": 1489073432732,
    "duration": 1,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能限流,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

环信即时通讯 IM 提供多个接口完成聊天室黑名单管理,包括查看、将用户添加、移除黑名单等。

名称 请求 描述
查询聊天室黑名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users 查看聊天室的黑名单列表。
添加单个用户至聊天室黑名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username} 将用户添加至聊天室的黑名单。
批量添加用户至聊天室黑名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users 将单个用户批量添加至聊天室的黑名单。
从聊天室黑名单移除单个用户 /{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username} 将用户从聊天室黑名单中移除。
批量从聊天室黑名单移除用户 /{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{usernames} 批量将用户从黑名单列表中移除。

查询聊天室黑名单

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
data Array 聊天室黑名单中的用户 ID。

请求示例

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users'

响应示例

{
  "action": "get",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users",
  "entities": [],
  "data": [
    "user2",
    "user3"
  ],
  "timestamp": 1543466293681,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp",
  "count": 2
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

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

接口描述

添加一个用户进入一个聊天室的黑名单。聊天室所有者无法被加入聊天室的黑名单。

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
username String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 说明
result 添加结果:
- true:添加成功;
- false:添加失败。
chatroomid 聊天室 ID。
action 执行操作。
user 被添加的用户 ID。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users/user1'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users/user1",
  "entities": [],
  "data": {
    "result": true,
    "action": "add_blocks",
    "user": "user1",
    "chatroomid": "66213271109633"
  },
  "timestamp": 1542539577124,
  "duration": 27,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

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

接口描述

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

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 说明
usernames Array 添加的用户 ID,多个用户 ID 通过逗号分隔,最多可添加 60 个。

响应体

参数 类型 说明
result Boolean 添加结果:
- true:添加成功;
- false:添加失败。
reason String 添加失败的原因。
chatroomid String 聊天室 ID。
action String 执行的操作。
user String 被添加的用户 ID。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' -d '{  
   "usernames": [  
     "user3","user4"  
   ]  
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users",
  "entities": [],
  "data": [
    {
      "result": false,
      "action": "add_blocks",
      "reason": "user: user3 doesn't exist in chatroom: 66213271109633",
      "user": "user3",
      "chatroomid": "66213271109633"
    },
    {
      "result": true,
      "action": "add_blocks",
      "user": "user4",
      "chatroomid": "66213271109633"
    }
  ],
  "timestamp": 1542540095540,
  "duration": 16,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

从聊天室黑名单移除单个用户

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
username String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
result Boolean 移除结果:
- true:移除成功;
- false:移除失败。
chatroomid String 聊天室 ID。
action String 执行的操作。
user String 被移除的用户 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users/user1'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users/user1",
  "entities": [],
  "data": {
    "result": true,
    "action": "remove_blocks",
    "user": "user1",
    "chatroomid": "66213271109633"
  },
  "timestamp": 1542540470679,
  "duration": 45,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

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

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{usernames}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
username String 必需 用户 ID,多个用户 ID 以逗号分隔,每次最多可传 60 个。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
result Boolean 移除结果:
- true:移除成功;
- false:移除失败。
chatroomid String 聊天室 ID。
action String 执行的操作。
user String 被移除的用户 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users/user1%2Cuser2'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/blocks/users/user1%2Cuser2",
  "entities": [],
  "data": [
    {
      "result": true,
      "action": "remove_blocks",
      "user": "user1",
      "chatroomid": "66213271109633"
    },
    {
      "result": true,
      "action": "remove_blocks",
      "user": "user2",
      "chatroomid": "66213271109633"
    }
  ],
  "timestamp": 1542541014655,
  "duration": 29,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

环信即时通讯 IM 提供多个接口完成聊天室白名单管理,包括查看、将用户添加、移除白名单等。

名称 请求 描述
查询聊天室白名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users 查询一个聊天室白名单中的用户列表。
添加单个用户至聊天室白名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username} 将指定的单个用户添加至聊天室白名单。
批量添加用户至聊天室白名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users 添加多个用户至聊天室白名单。
将用户移除聊天室白名单 /{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username} 将指定用户从聊天室白名单移除。

查询聊天室白名单

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
data Array 聊天室白名单中的用户 ID。

请求示例

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/white/users'

响应示例

{
  "action": "get",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/white/users",
  "entities": [],
  "data": [
    "wzy_test",
    "wzy_vivo",
    "wzy_huawei",
    "wzy_xiaomi",
    "wzy_meizu"
  ],
  "timestamp": 1594724947117,
  "duration": 3,
  "organization": "easemob-demo",
  "applicationName": "testapp",
  "count": 5
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

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

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 说明
result 添加结果:
- true:添加成功;
- false:添加失败。
groupid 群组 ID。
action 执行操作。
user 被添加的用户 ID。

请求示例

curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/{66213271109633}/white/users/{username}' 

响应示例

{
  "action": "post",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/white/users/wzy_xiaomi",
  "entities": [],
  "data": {
    "result": true,
    "action": "add_user_whitelist",
    "user": "wzy_xiaomi",
    "chatroomid": "66213271109633"
  },
  "timestamp": 1594724293063,
  "duration": 4,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

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

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 说明
usernames Array 待添加至聊天室白名单中的用户 ID,多个用户 ID 以逗号分隔,每次最多可传 60 个。

响应体

参数 类型 说明
result Boolean 添加结果:
- true:添加成功;
- false:添加失败。
reason String 添加失败的原因。
chatroomid String 聊天室 ID。
action String 执行的操作。
user String 被添加至聊天室白名单中的用户 ID。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' -d '{"usernames" : ["user1"]}' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/{chatroomid}/white/users'

响应示例

{
  "action": "post",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/white/users",
  "entities": [],
  "data": [
    {
      "result": true,
      "action": "add_user_whitelist",
      "user": "wzy_test",
      "chatroomid": "66213271109633"
    },
    {
      "result": true,
      "action": "add_user_whitelist",
      "user": "wzy_meizu",
      "chatroomid": "66213271109633"
    }
  ],
  "timestamp": 1594724634191,
  "duration": 2,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

将用户移除聊天室白名单

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
username String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
result Boolean 移除结果:
- true:移除成功;
- false:移除失败。
chatroomid String 聊天室 ID。
action String 执行的操作。
user String 添加的用户 ID,多个用户 ID 以逗号分隔。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/{66213271109633}/white/users/{username}'

响应示例

{
  "action": "delete",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/66213271109633/white/users/wzy_huawei,wzy_meizu",
  "entities": [],
  "data": [
    {
      "result": true,
      "action": "remove_user_whitelist",
      "user": "wzy_huawei",
      "chatroomid": "66213271109633"
    },
    {
      "result": true,
      "action": "remove_user_whitelist",
      "user": "wzy_meizu",
      "chatroomid": "66213271109633"
    }
  ],
  "timestamp": 1594725137704,
  "duration": 1,
  "organization": "hx",
  "applicationName": "hxdemo"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

环信即时通讯 IM 提供多个管理聊天室禁言列表的接口,包括获取、将用户添加、移除禁言列表等。

名称 请求 描述
获取聊天室的禁言列表 /{org_name}/{app_name}/chatrooms/{chatroom_id}/mute 获取当前聊天室的禁言用户列表。
禁言聊天室成员 /{org_name}/{app_name}/chatrooms/{chatroom_id}/mute 将聊天室成员禁言。
禁言聊天室全体成员 /{org_name}/{app_name}/chatrooms/{chatroom_id}/ban 对所有聊天室成员一键禁言。
解除聊天室禁言成员 /{org_name}/{app_name}/chatrooms/{chatroom_id}/mute/{member1}(,{member2},…) 将指定用户从禁言列表中移除。
解除聊天室全员禁言 /{org_name}/{app_name}/chatrooms/{chatroom_id}/ban 一键取消对聊天室全体成员的禁言。

获取禁言列表

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
expirelong 禁言到期的时间戳(从 1970 年 1 月 1 日 开始的毫秒数。如果禁言时间传的值为 “-1”,那么该时间戳为固定的 4638873600000 ,请参考 mute_duration 参数的说明)。
user String被禁言用户的 ID。

请求示例

curl -X GET HTTP://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "get",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute",
    "entities": [],
    "data": [{
        "expire": 1489158589481,
        "user": "user1"
    },
    {
        "expire": 1489158589481,
        "user": "user2"
    }],
    "timestamp": 1489072802179,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

禁言聊天室成员

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 是否必需 说明
mute_duration long 必需 禁言的时间,单位为毫秒,如果是 “-1” 代表永久(实际的到期时间为固定时间戳 4638873600000 ,即 2117-01-01 00:00:00 )。
usernames String 必需 要被添加禁言用户的 ID。

响应体

参数 说明
result添加禁言操作结果:
true:添加成功;
false:添加失败。
expire禁言到期的时间,Unix 时间戳,单位为毫秒。
user 被禁言用户的 ID。

请求示例

curl -X POST HTTP://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute -d '{"usernames":["user1"], "mute_duration":86400000}' -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "post",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute",
    "entities": [],
    "data": [{
        "result": true,
        "expire": 1489158589481,
        "user": "user1"
    }],
    "timestamp": 1489072189508,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

禁言聊天室全体成员

接口描述

对所有聊天室成员一键禁言,即将聊天室的所有成员均加入禁言列表。设置聊天室全员禁言后,仅聊天室白名单中的用户可在聊天室内发消息。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/ban

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
result Boolean 操作结果:
- true:禁言成功;
- false:禁言失败。
expire Long 禁言到期的时间。该时间为 Unix 时间戳,单位为毫秒。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/ban'

响应示例

{
  "action": "put",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/ban",
  "entities": [],
  "data": {
    "mute": true
  },
  "timestamp": 1594628861058,
  "duration": 1,
  "organization": "easemob-demo",
  "applicationName": "testapp"
} 

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

解除聊天室禁言成员

接口描述

将用户从禁言列表中移除,可以多个 member,用 “,” 号隔开。移除后,用户可以正常在聊天室中发送消息。

基本信息

方法:DELETE

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

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。
member1 String 必需 用户 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
resultBoolean移除禁言操作结果:
true:移除成功;
false:移除失败。
user String 被禁言用户的 ID。

请求示例

curl -X DELETE HTTP://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute/user1  -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "delete",
    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute/user1",
    "entities": [],
    "data": [{
        "result": true,
        "user": "user1"
    }],
    "timestamp": 1489072695859,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

解除聊天室全员禁言

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/ban

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
chatroom_id String 必需 聊天室 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
result Boolean 操作结果:
- true:解除成功;
- false:解除失败。

请求示例

curl -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/ban'

响应示例

{
  "action": "delete",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/ban",
  "entities": [],
  "data": {
    "mute": false
  },
  "timestamp": 1594628899502,
  "duration": 1,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

环信即时通讯 IM 提供多个管理超级管理员的接口,包括获取、添加、移除等。超级管理员身份给予了普通用户创建聊天室的权限,普通用户默认没有权限创建聊天室。

名称 请求 描述
获取超级管理员列表/{org_name}/{app_name}/chatrooms/super_admin 获取超级管理员列表。
添加超级管理员 /{org_name}/{app_name}/chatrooms/super_admin 添加用户至超级管理员列表。
移除超级管理员 /{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}从超级管理员列表列表中移除用户。

分页获取超级管理员列表

接口描述

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

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatrooms/super_admin

分页接入点:https://{host}/{org_name}/{app_name}/chatrooms/super_admin?pagenum={N}&pagesize={N}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
pagenum Int 非必需 当前页码,默认值为 1。
pagesize Int 非必需 每页返回的超级管理员数量,默认值为 10。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
dataArray超级管理员 ID 列表。

请求示例

curl -X GET http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin?pagenum=2&pagesize=2 -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

{
    "action": "get",
    "application": "9fa492a0-40b1-11e5-b1b9-a76b05da6904",
    "params": {
        "pagesize": [
            "2"
        ],
        "pagenum": [
            "2"
        ]
    },
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin",
    "entities": [],
    "data": [
        "hxtest1",
        "hxtest11",
        "hxtest10"
    ],
    "timestamp": 1596187292391,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp",
    "count": 3
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

添加超级管理员

接口描述

给用户添加聊天室超级管理员身份,一次只能添加一个。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatrooms/super_admin

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

请求体

参数 类型 是否必需 说明
superadmin String 必需 添加的用户名称。

响应体

参数 类型 说明
result Boolean 添加结果:
true:添加成功;
false:添加失败。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin' -d '{"superadmin":"u1"}'

响应示例

{
    "action": "post",
    "application": "9fa492a0-40b1-11e5-b1b9-a76b05da6904",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/hxdemo2/chatrooms/super_admin",
    "entities": [],
    "data": {
        "result": "success",
        "resource": ""
    },
    "timestamp": 1596187658017,
    "duration": 1,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。

撤销超级管理员

接口描述

撤销超级管理员权限。

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯云控制台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯云控制台注册项目时填入的应用名称。
superAdmin String 必需 超级管理员 ID。

请求头

参数 类型 是否必需 描述
Content-Type String 必需 内容类型:application/json
Authorization String 必需 Bearer ${YourAppToken} Bearer 是固定字符,后面加英文空格,再加上获取到的 app token 的值。

响应体

参数 类型 说明
resultBoolean添加结果:
true:添加成功;
false:添加失败。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin/user1'

响应示例

{
    "action": "delete",
    "application": "9fa492a0-40b1-11e5-b1b9-a76b05da6904",
    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin/hxtest10",
    "entities": [],
    "data": {
        "newSuperAdmin": "user1",
        "resource": ""
    },
    "timestamp": 1596187855832,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 该接口可能被限流了,请稍后重试。
500 服务器内部错误,请联系我们的技术支持团队。