群组管理 REST API

更新时间:2022-05-17

环信即时通讯 IM 提供了 REST API 管理 App 中的群组。

单个 App 创建群组数量有限制,单个用户可加入群组的数量依据版本而定,详见IM 即时通讯云价格

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

群组数据结构

字段名 类型 描述
id String 群组 ID,群组唯一标识符。
name String 群组名称,用户自定义,字符串类型,最大长度为 128 个字符。
description String 群组描述,用户自定义,字符串类型,最大长度为 512 个字符。
public Boolean 群组类型:
- true:公开群;
- false:私有群。
membersonly Boolean 加入群组是否需要群主或者群管理员审批。
- true:是;
- false:否。
allowinvites Boolean 是否允许普通群成员邀请新用户入群。
- true:允许群成员邀请新成员入群;
-(默认)false:只有群主才能加人。由于只有私有群才允许普通群成员邀请新用户入群,所以该参数仅对私有群有效。
maxusers Integer 群成员上限,创建群组时可修改。
affiliations_count Integer 现有成员总数。
affiliations Array 现有成员列表,包含群主和群成员。例如:“affiliations”:[{“owner”: “13800138001”},{“member”:“v3y0kf9arx”},{“member”:“xc6xrnbzci”}]。
owner String 群主的用户 ID。例如:{“owner”: “13800138001”}。
member String 群成员的用户 ID。例如:{“member”:“xc6xrnbzci”}。
invite_need_confirm Boolean 邀请加群,受邀用户是否需要确认。
- (默认)true:受邀用户需接受邀请才能入群;
- false:受邀用户无需确认,直接入群。
custom String 群组扩展信息,例如可以给群组添加业务相关标记,不能超过 1,024 字符。
mute Boolean 是否全员禁言。
- true:是;
- false:否。

群组除了群主和普通群成员之外,新增群管理员角色。

群组角色权限范围:群主 > 群管理员 > 普通群成员。

  • 群主拥有群的所有权限;
  • 群管理员拥有管理黑名单、禁言等权限;
  • 群主加管理员数量共 100 个,即管理员最多可添加 99 个。

路径公共参数

字段名 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_id String 必需 群组 ID。
username String 必需 用户 ID,长度不可超过 64 个字节长度。不可设置为空。支持以下字符集:
• 26 个小写英文字母 a-z;
• 26 个大写英文字母 A-Z;
• 10 个数字 0-9;
• “_”, “-”, “.”。
注意:
• 不能使用 Email 地址;
• 不能使用 UUID;
• 该参数不区分大小写,因此 Aaaa 为相同用户名;
• 请确保同一个 app 下,username 唯一;
username 用户 ID 是会公开的信息,请不要使用手机号等敏感信息直接注册,需要映射后注册!!!

请求头公共参数

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

响应体公共参数

以下为常出现的响应体参数及描述:

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

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

Authorization:Bearer ${YourAppToken}

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

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

名称 请求 描述
获取 app 中所有的群组(可分页) - 不分页:/{org_name}/{app_name}/chatgroups
- 分页:{org_name}/{app_name}/chatgroups?limit={N}&cursor={cursor}
获取应用下全部的群组信息。
获取一个用户参与的所有群组 - 不分页:/{org_name}/{app_name}/users/{username}/joined_chatgroups
- 分页:/{app_name}/users/{username}/joined_chatgroups?pagesize={}&pagenum={}
根据用户名称获取此用户加入的全部群组。
获取群组详情 /{org_name}/{app_name}/chatgroups/{group_ids} 根据群组 ID 获取群组的详情。
创建一个群组 /{org_name}/{app_name}/chatgroups 创建一个新群组。
修改群组信息 /{org_name}/{app_name}/chatgroups/{group_id} 修改群组的部分信息。
删除群组 /{org_name}/{app_name}/chatgroups/{group_id} 删除一个群组。
获取群组公告 {org_name}/{app_name}/chatgroups/{group_id}/announcement 获取指定群组 ID 的群组公告。
修改群组公告 {org_name}/{app_name}/chatgroups/{group_id}/announcement 修改指定群组 ID 的群组公告。
获取群组共享文件 - 不分页:{org_name}/{app_name}/chatgroups/{group_id}/share_files
- 分页:{org_name}/{app_name}/chatgroups/{group_id}/share_files?pagenum=1&pagesize=10
获取指定群组 ID 的群组共享文件。
上传群组共享文件 {org_name}/{app_name}/chatgroups/{group_id}/share_files 上传指定群组ID的共享文件。
下载群组共享文件 {org_name}/{app_name}/chatgroups/{group_id}/share_files/{file_id} 根据指定的群组 ID 与 file_id 下载群组共享文件。
删除群组共享文件 {org_name}/{app_name}/chatgroups/{group_id}/share_files/{file_id} 根据指定的群组 ID 与 file_id 删除群组共享文件。

获取 App 中所有的群组(可分页)

接口描述

获取应用下全部的群组信息的接口。

基本信息

方法:GET

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

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

路径参数

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

请求头

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

请求体

参数 类型 是否必需 备注
limit String 非必需 一次获取的群组数量。
cursor String 非必需 分页使用,传入游标后便从游标起始的地方进行查询,类似于数据库 limit 1,5 中 1 的作用,可以理解为页码。

响应体

在返回值中查看 data 字段包含的信息,符合查询和分页条件的群组列表,通用参数见文章开头通用参数列表。

参数 类型 说明
owner String 群主的 ID。例如:{“owner”: “user1}。
groupid String 群组 ID。
affiliations int 群组现有成员数。
type String “group” 群组类型。
last_modified String 最近一次修改的时间戳,单位为毫秒。
groupname String 群组名称。
count Int 实际取得的群组数量。
limit Int 每页获取聊天室成员的数量。默认值 10,最大值 100。超过 100 按照 100 返回。
cursor String 分页使用,传入游标后便从游标起始的地方进行查询,类似于数据库 limit 1,5 中 1 的作用,可以理解为页码。

请求示例

第一页

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups?limit=2'

第二页

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups?limit=2&cursor=ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06Z3JvdXA6ZWFzZW1vYi1kZW1vI3Rlc3RhcHA6Mg'

响应示例

{
    "action": "get",
    "params": {
        "limit": [
            "2"
        ]
    },
    "uri": "https://a1.easemob.com/easemob-demo/testapp/chatgroups",
    "entities": [],
    "data": [
        {
            "owner": "easemob-demo#testapp_user1",
            "groupid": "100743775617286960",
            "affiliations": 2,
            "type": "group",
            "last_modified": "1441021038124",
            "groupname": "testgroup1"
        },
        {
            "owner": "easemob-demo#testapp_user2",
            "groupid": "100973270123152176",
            "affiliations": 1,
            "type": "group",
            "last_modified": "1441074471486",
            "groupname": "testgroup2"
        }
    ],
    "timestamp": 1441094193812,
    "duration": 14,
    "cursor": "Y2hhdGdyb3VwczplYXNlbW9iLWRlbW8vY2hhdGRlbW91aV8z",
    "count": 2
}

响应码

状态码 描述
200 请求成功。
400 请求参数错误,请根据返回提示检查。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

获取单个用户加入的所有群组(可分页)

接口描述

根据用户名称获取该用户加入的全部群组接口。

基本信息

方法:GET

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

分页接入点:https://{host}/{app_name}/users/{username}/joined_chatgroups?pagesize={}&pagenum={}

路径参数

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

请求头参数

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

响应体参数

参数 类型 说明
groupid String 群组 ID。
groupname String 群组名称。

请求示例

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

分页获取示例:

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/users/user1/joined_chatgroups?pagesize=1&pagenum=100'

响应示例

{
  "action": "get",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/users/user1/joined_chatgroups",
  "entities": [],
  "data": [
    {
      "groupid": "66016455491585",
      "groupname": "testgroup1"
    },
    {
      "groupid": "66016467025921",
      "groupname": "testgroup2"
    },
  ],
  "timestamp": 1542359565885,
  "duration": 1,
  "organization": "easemob-demo",
  "applicationName": "testapp",
  "count": 2
}

分页获取响应示例:

{
    "action":"get",
    "application":"8be024f0-e978-11e8-b697-5d598d5f8402",
    "applicationName":"testapp",
    "count":0,
    "data":[

    ],
    "duration":0,
    "entities":[

    ],
    "organization":"easemob-demo",
    "params":{
        "pagesize":[
            "1"
        ],
        "pagenum":[
            "100"
        ]
    },
    "properties":{

    },
    "timestamp":1645177932072,
    "uri":"http://a1.easemob.com/easemob-demo/testapp/users/user1/joined_chatgroups"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

获取群组详情

接口描述

可以获取一个或多个群组的详情。当获取多个群组的详情时,返回所有存在的群组的详情;对于不存在的群组,返回 “group id doesn’t exist”。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_ids}

路径参数

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

请求头

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

响应体

参数 类型 说明
id String 群组 ID,群组唯一标识符。
name String 群组名称,根据用户输入创建,字符串类型,不超过 128 字符。
description String 群组描述,根据用户输入创建,字符串类型,不超过 512 字符。
membersonly Boolean 加入群组是否需要群主或者群管理员审批。
- true:是;
- false:否。
allowinvites Boolean 是否允许群成员邀请其他用户加入此群。
- true:允许群成员邀请其他用户加入此群;
- false:只有群主可以邀请其他用户入群。
maxusers Integer 群成员上限,创建群组的时候设置,可修改。
owner String 群主的用户 ID。例如:{“owner”: “user1”}。
created long 创建该群组的时间戳。
affiliations_count int 现有成员总数。
affiliations Array[] 现有成员列表,包含了 owner 和 member。例如:“affiliations”:[{“owner”: “user1”},{“member”:“user2”},{“member”:“user3”}]。
public Boolean 群组类型:
- true:公开群;
- false:私有群。
custom String 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。

请求示例

curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585'

响应示例

{
  "action": "get",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585",
  "entities": [],
  "data": [
    {
      "id": "66016455491585",
      "name": "testgroup1",
      "description": "testgroup1",
      "membersonly": false,
      "allowinvites": false,
      "maxusers": 200,
      "owner": "user1",
      "created": 1542356598609,
      "custom": "",
      "affiliations_count": 3,
      "affiliations": [
        {
          "member": "user3"
        },
        {
          "member": "user2"
        },
        {
          "owner": "user1"
        }
      ],
      "public": true
    }
  ],
  "timestamp": 1542360200677,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp",
  "count": 1
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

创建群组

接口描述

创建一个群组,并设置群组名称、群组描述、公开群/私有群属性、群成员最大人数(包括群主)、加入公开群是否需要批准、群主、群成员、群组扩展信息。

基本信息

方法:POST

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

路径参数

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

请求头

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

请求体

参数 类型 是否必需 备注
groupname String 必需 群组名称,最大长度为 128 字符。
desc String 必需 群组描述,最大长度为 512 字符。
public String 必需 是否是公开群。
maxusers Integer 非必需 群组最大成员数(包括群主),值为数值类型,默认值 200,具体上限请参考 环信即时通讯云控制台
allowinvites String 必需 是否允许群成员邀请别人加入此群:
- true:允许群成员邀请人加入此群;
- false:只有群主或者管理员才可以往群里加人。注:该参数仅对私有群有效,因为公开群不允许群成员邀请其他用户入群。
members_only String 非必需 用户申请入群是否需要群主或者群管理员审批,默认是 false
- true:是;
- false:否。 注:若允许普通群成员邀请用户入群(allowinvites 为 true),无需群主或群管理员审批。
owner String 必需 群组的管理员。
members String 非必需 群组成员,此属性为非必需,但是如果加此项,数组元素至少一个,不能超过 100 个。(注:群主 user1 不需要写入到 members 里面)
custom String 非必需 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。

响应体

参数 类型 说明
groupid String 群组 ID。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' -d '{  
   "groupname": "testgroup",  
   "desc": "test",  
   "public": true,  
   "maxusers": 300,  
   "owner": "testuser",  
   "members": [  
     "user2"  
   ]  
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups",
  "entities": [],
  "data": {
    "groupid": "66021836783617"
  },
  "timestamp": 1542361730243,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

修改群组信息

接口描述

修改成功的数据行会返回 true,失败为 false。请求 body 只接收 groupnamedescriptionmaxusersmembersonlyallowinvitescustom 六个属性,传不存在的字段,或者不能修改的字段会抛异常。

基本信息

方法:PUT

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}

路径参数

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

请求头

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

请求体

参数 类型 说明
groupname String 群组名称,修改时值不能包含斜杠(“/”),最大长度为 128 字符。
description String 群组描述,修改时值不能包含斜杠(“/”),最大长度为 512 字符。
maxusers Integer 群组成员最大数(包括群主),值为数值类型。
membersonly String 加入群组是否需要群主或者群管理员审批:
- true:是;
- false:否。
allowinvites String 是否允许群成员邀请别人加入此群:
- true:允许群成员邀请人加入此群;
- false:只有群主才可以往群里加人。
custom String 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。

响应体

参数 类型 说明
description String 群组描述:
- true:修改成功;
- false:修改失败。
maxusers Integer 群组最大成员数:
- true:修改成功;
- false:修改失败。
groupname String 群组名称:
- true:修改成功;
- false:修改失败。
membersonly Boolean 加入群组是否需要群主或者群管理员审批:
- true:是;
- false:否。
allowinvites Boolean 是否允许群成员邀请别人加入此群:
-true:允许群成员邀请人加入此群;
- false:只有群主才可以往群里加人。

请求示例

curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' -d '{  
   "groupname": "testgroup1",  
   "description": "test",  
   "maxusers": 300,
   "membersonly": true,
   "allowinvites": true
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617'

响应示例

{
  "action": "put",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617",
  "entities": [],
  "data": {
    "membersonly": true,
    "allowinvites": true,
    "description": true,
    "maxusers": true,
    "groupname": true
  },
  "timestamp": 1542363146301,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

删除群组

接口描述

删除一个群组的接口。

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}

路径参数

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

请求头

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

响应体

参数 类型 说明
success Boolean 群组删除结果:
- true:删除成功;
- false:删除失败。
groupid String 所删除群组 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.Ago ra.com/easemob-demo/testapp/chatgroups/66021836783617'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

获取群组公告

接口描述

获取指定群组 ID 的群组公告。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/announcement

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_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/chatgroups/66021836783617/announcement'

响应示例

{
  "action": "get",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/announcement",
  "entities": [],
  "data": {
    "announcement" : "群组公告..."
  },
  "timestamp": 1542363546590,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

修改群组公告

接口描述

修改指定群组 ID 的群组公告,注意群组公告的内容不能超过 512 个字符。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/announcement

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_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' -d '{"announcement" : "群组公告…"}' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/announcement'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/announcement",
  "entities": [],
  "data": {
    "id" : "66021836783617",
    "result" : true
  },
  "timestamp": 1542363546590,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

获取群组共享文件

接口描述

分页获取指定群组 ID 的群组共享文件,之后可以根据 response 中返回的 file_id,file_id 是群组共享文件的唯一标识,调用 下载群组共享文件 接口下载文件,或调用 删除群组共享文件接口删除文件。

默认是从第 1 页开始获取,1 页最多可以获取 1,000 条。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files

分页接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files?pagenum={N}&pagesize={N}

路径参数

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

请求头

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

响应体

参数 说明
file_id 群组共享文件的 ID,如果要下载该文件需要使用到这个 file_id。
file_name 群组共享文件名称。
file_owner 上传群组共享文件的用户 ID。
file_size 群组共享文件大小(字节)。
created 上传群组共享文件的时间。

请求示例

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/chatgroups/66021836783617/share_files?pagenum=1&pagesize=10'

响应示例

{
  "action": "get",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "params": {
        "pagesize": [
            "10"
        ],
        "pagenum": [
            "1"
        ]
    },
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files",
  "entities": [],
  "data": [
        {
            "file_id": "dbd88d20-e1d4-11ea-95fc-638fc2d59a8d",
            "file_name": "159781149272586.jpg",
            "file_owner": "u1",
            "file_size": 326127,
            "created": 1597811492594
        },
        {
            "file_id": "b30e0be0-e1d4-11ea-8732-172a3f85134f",
            "file_name": "159781141836993.jpg",
            "file_owner": "u1",
            "file_size": 326127,
            "created": 1597811424158
        }
    ],
  "timestamp": 1542363546590,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
404 群组 ID 不存在。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

上传群组共享文件

接口描述

上传指定群组 ID 的群组共享文件。注意上传的文件大小不能超过 10 MB。

分页获取指定群组 ID 的群组共享文件,然后可以根据响应中返回的 file_id(群组共享文件的唯一标识)调用 下载群组共享文件 接口下载群组的共享文件,或调用 删除群组共享文件接口删除群组的共享文件。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files

路径参数

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

请求头

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

响应体

参数 说明
file_url 群组共享文件的 URL,在环信即时通讯 IM 服务器上保存的地址。
group_id 群组 ID。
file_name 群组共享文件名称。
created 上传群组共享文件的时间。
file_id 群组共享文件 ID,可以用于下载共享文件和删除共享文件。
file_size 群组共享文件大小(字节)。

请求示例

curl -X POST 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files' -H 'Content-Type: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -H 'restrict-access: true' -F file=@/Users/test/image/IMG_3.JPG

响应示例

{

  "action" : "post",
  "application" : "7f7b5180-3f2b-11e5-9558-092397c841ef",
  "uri" : "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files",
  "entities" : [ ],
  "data" : {
    "file_url" : "https://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files/c6906aa0-ed19-11ea-b480-f3cf141d15c0",
    "group_id" : "66021836783617",
    "file_name" : "img_3.jpg",
    "created" : 1599050554954,
    "file_id" : "c6906aa0-ed19-11ea-b480-f3cf141d15c0",
    "file_size" : 13512
  },
  "timestamp" : 1599050554978,
  "duration" : 0,
  "organization" : "easemob-demo",
  "applicationName" : "testapp"

}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

下载群组共享文件

接口描述

根据指定的群组 ID 与 file_id 下载群组共享文件,file_id 是通过 获取群组共享文件 接口获取。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files/{file_id}

路径参数

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

请求头

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

响应体

参数 说明
file_url 群组共享文件的 URL,在环信即时通讯 IM 服务器上保存的地址。
group_id 群组 ID。
file_name 群组共享文件名称。
created 上传群组共享文件的时间。
file_id 群组共享文件 ID,可以用于下载共享文件和删除共享文件。
file_size 群组共享文件大小(字节)。

请求示例

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/chatgroups/66021836783617/share_files/b30e0be0-e1d4-11ea-8732-172a3f85134f'

响应示例

{
  "action" : "post",
  "application" : "7f7b5180-3f2b-11e5-9558-092397c841ef",
  "uri" : "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files",
  "entities" : [ ],
  "data" : {
    "file_url" : "https://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files/c6906aa0-ed19-11ea-b480-f3cf141d15c0",
    "group_id" : "66021836783617",
    "file_name" : "img_3.jpg",
    "created" : 1599050554954,
    "file_id" : "c6906aa0-ed19-11ea-b480-f3cf141d15c0",
    "file_size" : 13512
  },
  "timestamp" : 1599050554978,
  "duration" : 0,
  "organization" : "easemob-demo",
  "applicationName" : "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

删除群组共享文件

接口描述

根据指定的群组 ID 与 file_id 删除群组共享文件,file_id 是通过 获取群组共享文件 接口获取。

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/share_files/{file_id}

路径参数

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

请求头

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

响应体

参数 说明
group_id 群组 ID。
file_id 群组共享文件 ID,可以用于下载共享文件和删除共享文件
result 删除群组共享文件的结果:
- ture:删除成功;
- 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/chatgroups/66021836783617/share_files/b30e0be0-e1d4-11ea-8732-172a3f85134f'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66021836783617/share_files/b30e0be0-e1d4-11ea-8732-172a3f85134f",
  "entities": [],
  "data": {
      "group_id": "66021836783617",
      "file_id": "b30e0be0-e1d4-11ea-8732-172a3f85134f",
      "result": true
  },
  "timestamp": 1599049350114,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

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

名称 请求 描述
分页获取群组成员 /{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N}&pagesize={N} 分页获取一个群组的群成员列表。
添加单个群组成员 /{org_name}/{app_name}/chatgroups/{group_id}/users/{username} 添加用户至群组成员列表。
批量添加群组成员 /{org_name}/{app_name}/chatgroups/{chatgroupid}/users 批量添加用户至群组成员列表。
移除单个群组成员 /{org_name}/{app_name}/chatgroups/{group_id}/users/{username} 从群组成员列表中移除用户。
批量移除群组成员 /{org_name}/{app_name}/chatgroups/{group_id}/users/{usernames} 从群组成员列表中批量移除用户。
获取群管理员列表 /{org_name}/{app_name}/chatgroups/{group_id}/admin 获取群组管理员列表。
添加群管理员 /{org_name}/{app_name}/chatgroups/{group_id}/admin 添加用户至群组管理员列表。
移除群管理员 /{org_name}/{app_name}/chatgroups/{group_id}/admin/{oldadmin} 从群组管理员列表中移除用户。
转让群组 /{org_name}/{app_name}/chatgroups/{groupid} 转让群主权限。

分页获取群组成员

接口描述

可以分页获取群组成员列表的接口。若不分页获取,则一次返回所有数据。

基本信息

方法:GET

分页接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N}&pagesize={N}

路径参数

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

请求头

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

响应体

参数 说明
owner 群主的用户 ID。例如:{“owner”: “user1”}。
member 群成员的用户 ID。例如:{“member”:“user2”}。

请求示例

curl -X GET HTTP://a1.easemob.com/easemob-demo/testapp/chatgroups/10130212061185/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/chatgroups/10130212061185/users",
    "entities": [],
    "data": [
    {
            "member": "user1"
    },
    {
            "member": "user2"
    }
    ],
    "timestamp": 1489074511416,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp",
    "count": 2
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

添加单个群组成员

接口描述

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

基本信息

方法:POST

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

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_id String 必需 群组 ID。
username String 必需 用户 ID。用户的唯一登录账号。长度在 64 字节内,不可设置为空。支持以下字符集:
- 26 个小写英文字母 a-z
- 26 个大写英文字母 A-Z
- 10 个数字 0-9
- “_”, “-”, “.”
注意:
- 不区分大小写。
- 同一个 app 下,用户名唯一。

请求头

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

响应体

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

请求示例

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/chatgroups/66016455491585/users/user4'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

批量添加群组成员

接口描述

为群组添加多个成员,一次最多可以添加 60 位成员。如果所有用户均已是群成员,将添加失败,并返回错误。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{chatgroupid}/users

路径参数

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

请求头

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

请求体

参数 类型 是否必需 描述
usernames Array 必需 username1/username2 要添加到群中的成员用户名。

响应体

参数 说明
newmembers 添加的群组成员 ID。
groupid 群组 ID。
action 执行的操作。

请求示例

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' -d '{  
   "usernames": [  
     "user4","user5"  
   ]  
 }' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585/users'

响应示例

{
  "action": "post",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585/users",
  "entities": [],
  "data": {
    "newmembers": [
      "user5",
      "user4"
    ],
    "groupid": "66016455491585",
    "action": "add_member"
  },
  "timestamp": 1542365557942,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

移除单个群组成员

接口描述

从群中移除某个成员。如果被移除用户不是群成员,将移除失败,并返回错误。

基本信息

方法:DELETE

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

路径参数

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

请求头

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

响应体

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

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585/users/user3'

响应示例

{
  "action": "delete",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585/users/user3",
  "entities": [],
  "data": {
    "result": true,
    "action": "remove_member",
    "user": "user3", 
    "groupid": "66016455491585"
  },
  "timestamp": 1542365943067,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

批量移除群组成员

接口描述

移除群成员,用户名之间用英文逗号分隔。建议一次最多移除 60 个群成员。如果所有被移除用户均不是群成员,将移除失败,并返回错误。

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users/{memebers}

路径参数

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

请求头

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

响应体

参数 类型 说明
result Boolean 操作结果:
- true:移除成功;
- false:移除失败。
action String 执行的操作,例如:remove_member:移除群组成员。
reason String 操作失败的原因。
user String 被移除成员的用户名。
groupid String 操作的群组 ID。

请求示例

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMtduapFumREei8DkfcegKdAAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnHD8qUwBPGgC0sPDXWLwWYh8ObqXytVlhbUhCTnbiIPi0oNGS8j2pDg' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585/users/ttestuser0015981,user2,user3'

响应示例

{
    "action": "delete",
    "application": "9b848cf0-fafe-11e4-b5b8-0f74e8e740f7",
    "uri": "https://a1.easemob.com/easemob-demo/testapp",
    "entities": [],
    "data": [{
        "result": false,
        "action": "remove_member",
        "reason": "user ttestuser0015981 doesn't exist.",
        "user": "user1",
        "groupid": "1433492852257879"
    },
    {
        "result": true,
        "action": "remove_member",
        "user": "user2",
        "groupid": "1433492852257879"
    },
    {
        "result": true,
        "action": "remove_member",
        "user": "user3",
        "groupid": "1433492852257879"
    }],
    "timestamp": 1433492935318,
    "duration": 84,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

获取群管理员列表

接口描述

获取群组管理员列表的接口。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin

路径参数

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

请求头

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

响应体

参数 类型 说明
data Array 群组管理员信息。

请求示例

curl -X GET HTTP://a1.easemob.com/easemob-demo/testapp/chatgroups/10130212061185/admin -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

添加群管理员

接口描述

将一个群成员角色权限提升为群管理员。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin

路径参数

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

请求头

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

请求体

参数 类型 是否必需 描述
newadmin String 必需 添加的新管理员用户 ID。

响应体

参数 类型 说明
data String 添加的新管理员用户 ID。

请求示例

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

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

移除群管理员

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin/{oldadmin}

路径参数

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

请求头

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

响应体

参数 类型 说明
result Boolean 操作结果:
- true:表示移除成功;
- false:表示移除失败。
oldadmin String 被移除的管理员 ID。

请求示例

curl -X DELETE HTTP://a1.easemob.com/easemob-demo/testapp/chatgroups/10130212061185/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/chatgroups/10130212061185/admin/user1",
    "entities": [],
    "data": {
        "result": "success",
        "oldadmin": "user1"
    },
    "timestamp": 1489073432732,
    "duration": 1,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token,token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

转让群组

接口描述

修改群主为同一群组中的其他成员。

基本信息

方法:PUT

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}

路径参数

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

请求头

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

请求体参数

参数 类型 说明
newowner String 群组的新管理员 ID。

响应体参数

参数 类型 说明
newowner Boolean 操作结果:
- true:转让成功。
- false:转让失败。

请求示例

curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' -d '{     "newowner": "user2"   }' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585'

响应示例

{
  "action": "put",
  "application": "8be024f0-e978-11e8-b697-5d598d5f8402",
  "uri": "http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585",
  "entities": [],
  "data": {
    "newowner": true
  },
  "timestamp": 1542537813420,
  "duration": 0,
  "organization": "easemob-demo",
  "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

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

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

查询群组黑名单

接口描述

查询一个群组黑名单中的用户列表。位于黑名单中的用户查看不到该群组的信息,也无法收到该群组的消息。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_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/chatgroups/66016455491585/blocks/users'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

添加单个用户至群组黑名单

接口描述

添加一个用户进入一个群组的黑名单。群主无法被加入群组的黑名单。

用户进入群组黑名单后,会收到消息:You are kicked out of the group xxx。之后,该用户查看不到该群组的信息,也收不到该群组的消息。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_id String 必需 群组 ID。
username 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 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatgroups/66016455491585/blocks/users/user1'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

批量添加用户至群组黑名单

接口描述

将多个用户添加一个群组的黑名单。你一次最多可以添加 60 个用户至群组黑名单。群主无法被加入群组的黑名单。

用户进入群组黑名单后,会收到消息:You are kicked out of the group xxx。之后,该用户查看不到该群组的信息,也收不到该群组的消息。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users

路径参数

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

请求头

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

请求体

参数 类型 说明
usernames Array 添加的用户名 ID。

响应体

参数 类型 说明
result Boolean 添加结果:
- true:添加成功;
- false:添加失败。
reason String 添加失败的原因。
groupid 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/chatgroups/66016455491585/blocks/users'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

从群组黑名单移除单个用户

接口描述

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

基本信息

方法:DELETE

接入点:/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{username}

路径参数

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

请求头

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

响应体

参数 类型 说明
result Boolean 移除结果:
- true:移除成功;
- false:移除失败。
groupid 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/chatgroups/66016455491585/blocks/users/user1'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

从群组黑名单批量移除用户

接口描述

将多名指定用户从群组黑名单中移除。对于群组黑名单中的用户,如果需要将其再次加入群组,需要先将其从群组黑名单中移除。

基本信息

方法:DELETE

接入点:/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{usernames}

路径参数

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

请求头

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

响应体

参数 类型 说明
result Boolean 移除结果:
- true:移除成功;
- false:移除失败。
groupid 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/chatgroups/66016455491585/blocks/users/user1%2Cuser2'

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

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

名称 请求 描述
查询群组白名单 /{org_name}/{app_name}/chatgroups/{group_id}/white/users 查询群组白名单中的用户列表。
添加单个用户至群组白名单 /{org_name}/{app_name}/chatgroups/{group_id}/white/users/{username}} 将指定的单个用户添加至群组白名单。
批量添加用户至群组白名单 /{org_name}/{app_name}/chatgroups/{group_id}/white/users 添加多个用户至群组白名单。
将用户移除群组白名单 {org_name}/{app_name}/chatgroups/{group_id}/white/users/{username} 将指定用户从群组白名单中移除。

查询群组白名单

接口描述

查询一个群组白名单中的用户列表。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_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/chatgroups/{groupid}/white/users'

响应示例

{
  "action": "get",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://localhost:8080/hx/hxdemo/chatgroups/120824965169153/white/users",
  "entities": [],
  "data": [
    "wzy_test",
    "wzy_vivo",
    "wzy_huawei",
    "wzy_xiaomi",
    "wzy_meizu"
  ],
  "timestamp": 1594724947117,
  "duration": 3,
  "organization": "hx",
  "applicationName": "hxdemo",
  "count": 5
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429、503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

添加单个用户至群组白名单

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users/{username}

路径参数

参数 类型 是否必需 描述
host String 必需 你在环信即时通讯 IM 管理后台注册项目时所在的集群服务器地址。
org_name String 必需 即时通讯服务分配给每个企业(组织)的唯一标识。你可以通过控制台获取该字段。
app_name String 必需 你在环信即时通讯 IM 管理后台注册项目时填入的应用名称。
group_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/chatgroups/{groupid}/white/users/{username}' 

响应示例

{
  "action": "post",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://localhost:8080/hx/hxdemo/chatgroups/120824965169153/white/users/wzy_xiaomi",
  "entities": [],
  "data": {
    "result": true,
    "action": "add_user_whitelist",
    "user": "wzy_xiaomi",
    "groupid": "120824965169153"
  },
  "timestamp": 1594724293063,
  "duration": 4,
  "organization": "hx",
  "applicationName": "hxdemo"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

批量添加用户至群组白名单

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users

路径参数

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

请求头

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

请求体

参数 类型 说明
usernames Array 待添加至群组白名单中的用户 ID。

响应体

参数 类型 说明
result Boolean 添加结果:
- true:添加成功;
- false:添加失败。
reason String 添加失败的原因。
groupid 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/chatgroups/{groupid}/white/users'

响应示例

{
  "action": "post",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://localhost:8080/hx/hxdemo/chatgroups/120824965169153/white/users",
  "entities": [],
  "data": [
    {
      "result": true,
      "action": "add_user_whitelist",
      "user": "wzy_test",
      "groupid": "120824965169153"
    },
    {
      "result": true,
      "action": "add_user_whitelist",
      "user": "wzy_meizu",
      "groupid": "120824965169153"
    }
  ],
  "timestamp": 1594724634191,
  "duration": 2,
  "organization": "hx",
  "applicationName": "hxdemo"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

将用户移除群组白名单

接口描述

将指定用户从群组白名单中移除。你每次最多可移除 60 个用户。

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users/{username}

路径参数

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

请求头

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

响应体

参数 类型 说明
result Boolean 移除结果:
- true:移除成功;
- false:移除失败。
groupid 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/chatgroups/{groupid}/white/users/{username}'

响应示例

{
  "action": "delete",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://localhost:8080/hx/hxdemo/chatgroups/120824965169153/white/users/wzy_huawei,wzy_meizu",
  "entities": [],
  "data": [
    {
      "result": true,
      "action": "remove_user_whitelist",
      "user": "wzy_huawei",
      "groupid": "120824965169153"
    },
    {
      "result": true,
      "action": "remove_user_whitelist",
      "user": "wzy_meizu",
      "groupid": "120824965169153"
    }
  ],
  "timestamp": 1594725137704,
  "duration": 1,
  "organization": "hx",
  "applicationName": "hxdemo"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

环信即时通讯 IM 提供多个接口进行群组禁言列表管理,包括查看、将用户添加、移除禁言列表等。

名称 请求 描述
获取禁言列表 /{org_name}/{app_name}/chatgroups/{group_id}/mute 获取禁言列表。
禁言单个群成员 /{org_name}/{app_name}/chatgroups/{group_id}/mute 对单个群成员禁言。
禁言全体成员 /{org_name}/{app_name}/chatgroups/{group_id}/ban 对所有群组成员一键禁言。
解除成员禁言 /{org_name}/{app_name}/chatgroups/{group_id}/mute/{member1}(,{member2},…) 将一个或多个群成员移除禁言列表。
解除全员禁言 /{org_name}/{app_name}/chatgroups/{group_id}/ban 一键取消对群组全体成员的禁言。

获取禁言列表

获取当前群组的禁言用户列表。

接口描述

将用户从禁言列表中移除。移除后,用户可以正常在群中发送消息。

基本信息

方法:GET

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/mute

路径参数

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

请求头

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

响应体

参数 说明
expire 禁言到期的时间,单位为毫秒。
user 被禁言用户的 ID。

请求示例

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

响应示例

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

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

禁言单个群成员

接口描述

对单个群成员禁言。群成员被禁言后,将无法在群中发送消息。

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/mute

路径参数

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

请求头

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

请求体

参数 类型 说明
mute_duration Long 禁言时长,单位为毫秒。
usernames Array 要被添加禁言用户的 ID。

响应体

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

请求示例

curl -X POST HTTP://a1.easemob.com/easemob-demo/testuser/chatgroups/10130212061185/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/chatgroups/10130212061185/mute",
    "entities": [],
    "data": [{
        "result": true,
        "expire": 1489158589481,
        "user": "user1"
    }],
    "timestamp": 1489072189508,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

禁言全体成员

接口描述

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

基本信息

方法:POST

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/ban

路径参数

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

请求头

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

响应体

参数 类型 说明
mute 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/chatgroups/{groupid}/ban'

响应示例

{
  "action": "post",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://localhost:8080/hx/hxdemo/chatgroups/120824965169153/ban",
  "entities": [],
  "data": {
    "mute": true
  },
  "timestamp": 1594628861058,
  "duration": 1,
  "organization": "hx",
  "applicationName": "hxdemo"
} 

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

解除成员禁言

接口描述

将一个或多个群成员移除禁言列表。移除后,群成员可以在群组中正常发送消息。

基本信息

方法:DELETE

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

路径参数

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

请求头

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

响应体

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

请求示例

curl -X DELETE HTTP://a1.easemob.com/easemob-demo/testapp/chatgroups/10130212061185/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/chatgroups/10130212061185/mute/user1",
    "entities": [],
    "data": [{
        "result": true,
        "user": "user1"
    }],
    "timestamp": 1489072695859,
    "duration": 0,
    "organization": "easemob-demo",
    "applicationName": "testapp"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。

解除全员禁言

接口描述

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

基本信息

方法:DELETE

接入点:https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/ban

路径参数

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

请求头

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

响应体

参数 类型 说明
mute 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/chatgroups/{groupid}/ban'

响应示例

{
  "action": "delete",
  "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
  "uri": "http://localhost:8080/hx/hxdemo/chatgroups/120824965169153/ban",
  "entities": [],
  "data": {
    "mute": false
  },
  "timestamp": 1594628899502,
  "duration": 1,
  "organization": "hx",
  "applicationName": "hxdemo"
}

响应码

状态码 描述
200 请求成功。
404 群组 ID 不存在。
401 鉴权失败(无 token、token 错误或者过期),请重新获取 token 再试。
429,503 或者其他 5xx 单位时间内请求过多,请稍后重试。
500 服务器内部错误,一般是 mysql 错误。如果问题持续存在,请联系我们的技术支持团队。