环信超级社区的频道 API

更新时间:2022-08-18

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

请求参数

参数 类型 是否必需 描述
host String 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见获取环信即时通讯 IM 的信息
org_name String 环信即时通讯 IM 为每个公司(组织)分配的唯一标识。详见获取环信即时通讯 IM 的信息
app_name String 你在环信即时通讯云控制台创建应用时填入的应用名称。详见获取环信即时通讯 IM 的信息
server_id String 社区 ID。
channel_id String 频道 ID。
user_id String 用户 ID。
role Int 频道成员的角色:
- 0:频道所有者;
- 1:频道的普通成员。
limit Int 每次期望返回的数量。该参数仅在分页获取时为必需。
cursor String 游标,数据查询的起始位置。该参数仅在分页获取时为必需。

响应参数

参数 类型 描述
name String 频道名称。
type Int 频道类型:
- 0:公开频道;
- 1:私密频道。
invite_mode Int 邀请用户时是否需受邀方确认才能加入频道:
- 0:受邀方直接加入频道,无需确认;
- 1:受邀方需确认是否加入频道。
description String 频道描述。
custom String 频道的扩展信息。
default_channel Int 是否为社区的默认频道:
- 0:否;
- 1:是。
user_id String 环信用户 ID。
role Int 频道成员的角色:
- 0:频道所有者;
- 1:频道的普通成员。
created Long 频道的创建时间,Unix 时间戳,单位为毫秒。
cursor String 游标,数据查询的起始位置。该参数仅在分页获取时为必需。
server_id String 社区 ID。

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

Authorization:Bearer ${YourAppToken}

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

创建频道

每个社区最多可以创建 100 个频道。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/channel
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。
请求 body
参数 类型 是否必需 描述
server_id String 社区 ID。
name String 频道名称,长度不能超过 50 个字符。
type Int 频道类型:
- 0:公开频道;
- 1:私密频道。
rank Int 频道成员数量上限级别:
- (默认)0:2,000;
- 1:20,000;
- 2:100,000。
invite_mode Int 邀请用户时是否需受邀方确认才能加入频道:
- 0:受邀方直接加入频道,无需确认;
- 1:受邀方需确认是否加入加入频道。
description String 频道描述,长度不能超过 500 个字符。
custom String 频道扩展信息,例如可以给社区添加业务相关的标记,长度不能超过 500 个字符。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
channel_id String 频道 ID。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel'
-d '{
    "server_id" : "19VM9oPBasxxxxxx0tvWViEsdM",
    "name" : "easemob",
    "type" : 0,
    "rank":0,
    "invite_mode" : 0,
    "description" : "chat Channel",
    "custom" : "custom"
}'
响应示例
{
    "code": 200,
    "channel_id": "198900125668"
}

修改频道信息

修改指定频道的信息。

HTTP 请求

PUT https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}?serverId={server_id}
路径参数

参数及描述详见 公共参数

查询参数
参数 类型 是否必需 描述
server_id String 频道所属社区的 ID。
请求 header
参数 类型 是否必需描述
Content-Type String内容类型。请填 application/json
Accept String内容类型。请填 application/json
AuthorizationString该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。
请求 body
参数 类型 是否必需描述
name String频道名称,长度不能超过 50 个字符。
rank Int 频道的成员数量上限级别。若要设置为 1 或 2 级别,需要联系商务。
- (默认)0:2,000;
- 1:20,000;
- 2:100,000。
invite_modeInt 邀请用户时是否需受邀方确认才能加入频道:
- 0:受邀方直接加入频道,无需确认;
- 1:受邀方需确认是否加入加入频道。
descriptionString频道描述,长度不能超过 500 个字符。
custom String频道的扩展信息,例如可以给社区添加业务相关的标记,长度不能超过 500 个字符。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
channel Json 频道详情。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX' -d '{
 "name" : "easemob",
 "rank" : 1,
 "description" : "chat Channel",
  "custom" : "custom"
}'
响应示例
{
    "code": 200,
    "channel": {
        "name": "easemob",
        "rank" : 1,
        "type": 1,
        "description": "chat Channel11",
        "custom": "custom",
        "created": 1658201254843,
        "server_id": "19UyPIsiwxxxxxxxgLrfI9Z",
        "channel_id": "198900125668",
        "invite_mode": 0,
        "default_Channel": 1
    }
}

查询指定频道

查询指定的频道。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}?serverId={server_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
server_id String 频道所属社区的 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
channel Json 频道详情。
channel.rank Int 频道的成员数量上限级别。
- (默认)0:2,000;
- 1:20,000;
- 2:100,000。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel?serverId=XXX'
响应示例
{
    "code": 200,
    "channel": {
        "name": "easemob",
        "type": 1,
        "description": "chat Channel11",
        "custom": "custom",
        "created": 1658201254843,
        "server_id": "19UyPIsiwxxxxxxxgLrfI9Z",
        "channel_id": "198900125668",
        "invite_mode": 0,
        "rank" : 0,
        "default_channel": 1
    }
}

获取单个社区下的所有公开频道

获取单个社区下的所有公开频道。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/channel/public?serverId={server_id}

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/channel/public?serverId={server_id}&limit={limit}&cursor={cursor} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
server_id String 频道所属社区的 ID。
limit Int 每页获取的频道数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
count Int 获取到的频道数量。
channelsList获取到的频道详情列表。
cursor String 游标,指定下次查询的开始位置。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/public?serverId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/public?serverId=XXX&limit=1&cursor=XXX'
响应示例
{
    "code": 200,
    "count": 1,
    "channels": [
        {
            "name": "easemob",
                "type": 0,
            "rank" : 0,
                "description": "chat Channel11",
                "custom": "custom",
                "created": 1658201254843,
                "server_id": "19UyPIsiwxxxxxxxgLrfI9Z",
                "channel_id": "198900125668",
                "invite_mode": 0,
                "default_Channel": 1
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

获取单个用户已加入的频道列表

获取单个用户已加入的频道列表。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/channel/user/joined/list?userId={user_id}&serverId={server_id}

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/channel/user/joined/list?userId={user_id}&serverId={server_id}&limit={limit}&cursor={cursor} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
user_Id String 用户 ID。
server_id String 频道所属社区的 ID。
limit Int 每页获取的频道数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
channels List 获取到的频道详情列表。
count Int 获取到的频道数量。
cursor String 游标,指定下次查询的开始位置。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/user/joined/list?userId=XXX&serverId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/user/joined/list?userId=XXX&serverId=XXX&limit=1&cursor=XXX'
响应示例
{
    "code": 200,
    "count": 1,
    "channels": [
        {
          "name": "easemob",
          "type": 1,
          "description": "chat Channel11",
          "custom": "custom",
          "created": 1658201254843,
          "server_id": "19UyPIsiwxxxxxxxgLrfI9Z",
          "channel_id": "198900125668",
          "invite_mode": 0,
          "default_Channel": 1
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

获取当前用户可见的所有私密频道列表

获取当前用户可见的所有私密频道列表。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/channel/private?serverId={server_id}

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/channel/private?serverId={server_id}&limit={limit}&cursor={cursor} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
server_id String 频道所属社区的 ID。
limit Int 每页获取的私密频道数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
count Int 获取到的频道数量。
channels List 获取到的私密频道详情列表。
cursor String 游标,指定下次查询的开始位置。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/private?serverId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/private?serverId=XXX&limit=1&cursor=XXX'
响应示例
{
    "code": 200,
    "count": 1,
    "channels": [
        {
            "name": "easemob",
                "type": 1,
            "rank": 0,
                "description": "chat Channel11",
                "custom": "custom",
                "created": 1658201254843,
                "server_id": "19UyPIsiwxxxxxxxgLrfI9Z",
                "channel_id": "198900125668",
                "invite_mode": 0,
                "default_Channel": 1
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

删除频道

删除指定的频道。

HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}?serverId={server_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
server_id String 频道所属社区的 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX?serverId=XXX'
响应示例
{
    "code": 200
}

通过 RESTful API 在频道中发送消息与在群组中发送消息的方式类似,唯一的区别在于请求体中的 to 参数需要设置为频道 ID。详见 发送群聊消息

添加消息 Reaction

添加消息 Reaction。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/reaction
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。
请求 body
参数 类型 是否必需 备注
user_id String 用户 ID。
message_id String 消息 ID。
message String 表情 ID,与客户端一致。长度不可超过 128 个字符。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
reaction_id String Reaction ID。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/reaction'
-d '{
  "user_id" : "user1",
  "message_id" : "131345390",
  "message" : "message"
}'
响应示例
{
  "code" : 200,
  "reaction_id" : "15890012560"
}

获取指定消息的 Reaction

获取指定消息的 Reaction。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/reaction/user/{user_id}?msgIdList={message_id}&channelId={channel_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
msgIdList String Reaction 所属消息的 ID。
channelId String 消息所属频道的 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
count Int Reaction 数量。
msgId String Reaction 所属消息的 ID。
reactionList List Reaction 列表及其详细信息。
reactionList.reactionId String Reaction ID。
reactionList.message String Reaction 名称
reactionList.state Bool 发送该请求的用户是否向消息添加了 Reaction:
- true:是;
- false:否。
reactionList.count Int 向消息添加了该 Reaction 的用户数量。
reactionList.userList Long 添加了该 Reaction 的用户 ID 列表。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/reaction/user/XXX?msgIdList=XXX&channelId=XXX'
响应示例
{
    "code":200,
    "count" : 1,
    "reactions":[
        {
            "msgId":"131345390",
            "reactionList":[
                {
                    "reactionId":"944330310986837168",
                    "message":"message123456",
                    "count":2,
                    "state":"该用户是否追加了此reaction",
                    "userList":[
                        "user1",
                        "user2"
                    ]
                }
            ]
        }
    ]
}

删除指定消息的 Reaction

删除指定消息的 Reaction。

HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/circle/reaction/user/{user_id}?messageId={message_id}&message={message}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
message_id String Reaction 所属消息的 ID。
message String 要移除的表情的 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/reaction/user/XXX?messageId=XXX&message=XXX'
响应示例
{
  "code" : 200
}

将用户加入频道

将用户加入频道,每个用户最多可以加入 10,000 个频道。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/join?userId={user_id}&serverId={server_id}
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
channel Json 频道详情。

具体字段及描述详见公共参数

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/join?userId=XXX&serverId=XXX'
响应示例
{
    "code": 200,
    "channel": {
        "name": "easemob",
        "type": 1,
        "description": "chat Channel11",
        "custom": "custom",
        "created": 1658201254843,
        "server_id": "19UyPIsiwxxxxxxxgLrfI9Z",
        "channel_id": "198900125668",
        "invite_mode": 0,
        "default_Channel": 1
    }
}

将成员移出频道

将指定成员移出频道。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/remove?userId={user_id}&serverId={server_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
user_id String 用户 ID。
server_id String 社区 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/user/remove?userId=XXX&serverId=XXX'
响应示例
{
    "code": 200
}

查询用户是否在频道

查询用户是否在频道中。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/{user_id}?serverId={server_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
server_id String 频道所属社区的 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
result Boolean 查询结果:
- true:用户在频道中;
- false:用户不在频道中。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/user/XXX?serverId=XXX'
响应示例
{
    "code": 200,
    "result": true
}

获取频道的成员列表

获取频道的成员列表。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/users?serverId={server_id}

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/users?serverId={server_id}&limit={limit}&cursor={cursor} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
server_id String 频道所属社区的 ID。
limit Int 每页获取的成员数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
count Int 获取到的成员数量。
users List 获取到的成员详情列表。
users.user_id String 用户 ID
users.role Int 用户在频道中的角色:
- 0: 所有者;
- 1:普通成员。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/users?serverId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/users?serverId=XXX&limit=1&cursor=XXX'
响应示例
{
    "code": 200,
    "count": 1,
    "users": [
        {
            "user_id" : "user1",
            "role" : 0
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

获取频道的禁言列表

获取频道的禁言列表。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/mute/list?serverId={server_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
server_id String 频道所属社区的 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
mute_users List 被禁言用户的详情列表。
mute_users.expire Long 禁言的到期时间,Unix 时间戳,单位为毫秒。
mute_users.user String 被禁言的成员的用户 ID。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/Channel/XXX/user/mute/list?serverId=XXX'
响应示例
{
  "code" : 200
  "mute_users" : [
    {
      "expire" : 86400000,
      "user" : "u1"
    },
    {
      "expire" : 86400000,
      "user" : "u2"
    }
  ]
}

将成员加入频道禁言列表

将成员加入频道禁言列表。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/mute
路径参数

其它参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。
请求 body
参数 类型 是否必需 备注
server_id String 社区 ID。
user_id String 被禁言的成员的用户 ID。
duration Long 禁言时长,单位为毫秒。若不传该参数为永久禁言。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/user/mute' -d '{
  "server_id" : "19UyPIsiwxxxxxxxgLrfI9Z",
  "user_id" : "u1",
  "duration" : 86400
}'
响应示例
{
    "code": 200
}

将成员移出频道禁言列表

将成员移出频道禁言列表。

HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/mute?serverId={server_id}&userId={user_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
server_id String 频道所属社区的 ID。
user_id String 要禁言的用户 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/XXX/user/mute?serverId=XXX&userId=XXX'
响应示例
{
    "code": 200
}

创建子区

创建子区。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/thread
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。
请求 body
参数 类型 是否必需 备注
channel_id String 频道 ID。
user_id String 用户 ID。
name String 子区名称。
message_id String 消息 ID。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
thread_id String 子区 ID。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread' -d '{
  "channel_id" : "156900086",
  "user_id" : "user1",
  "message_id" : 0,
  "name" : "thread-name"
}'
响应示例
{
  "code" : 200,
  "thread_id" : "15890012560"
}

修改子区信息

修改指定子区的信息。

HTTP 请求

PUT https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。
请求 body
参数 类型 是否必需 备注
name String 子区名称。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX' -d '{
  "name" :"thread-name"
}'
响应示例
{
  "code" : 200
}

查询子区的详情

查询指定子区的详情。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}
路径参数

其它参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
id String 子区 ID。
msgId String 子区的父消息 ID。
channelId String 子区所属频道的 ID。
owner String 子区创建者的用户 ID。
created Number 子区创建时间,Unix 时间戳,单位为毫秒。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX'
响应示例
{
    "code": 200
    "id" : "1895600",
    "msgId" : "198008034121000",
    "channelId" : "156009089",
    "owner" : "user1",
    "created" : 1650856033420
}

删除子区

删除指定的子区。

HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}
路径参数

其它参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX'
响应示例
{
    "code": 200
}

加入子区

加入指定的子区。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}/user/join?userId={user_id}
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX/user/join?userId=XXX'
响应示例
{
  "code" : 200
}

将成员移出子区

将成员移出指定的子区。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}/user/remove?userId={user_id}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
user_id String 要移出子区的用户 ID。
请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX/user/remove?userId=XXX'
响应示例
{
  "code" : 200
}

用户获取自己创建的子区

用户获取自己创建的子区。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/thread/created?userId={user_id}&channelId={channel_id}

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/thread/created?userId={user_id}&channelId={channel_id}&limit={limit}&cursor={cursor}
路径参数

其它参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
user_id String 用户 ID。
channel_id String 子区所属频道的 ID。
limit Int 每页获取的频道数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
threads List 获取到的子区详情列表。
count Int 获取到的子区数量。
threads.id String 子区 ID。
threads.msgId String 子区的父消息 ID。
threads.channelId String 子区所属频道的 ID。
threads.owner String 子区创建者的用户 ID。
threads.created Number 子区创建时间,Unix 时间戳,单位为毫秒。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/created?userId=XXX&channelId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/created?userId=XXX&channelId=XXX&limit=1&cursor=XXX'
响应示例
{
  "code" : 200,
  "threads" : [
    {
      "id" : "1895600",
      "msgId" : "198008034121000",
      "channelId" : "156009089",
      "owner" : "user1",
      "created" : 1650856033420
    }
    ],
     "cursor" : "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06ZGlzY29yZDo2MjI0MjEwMiM5MDoy"
}

用户获取频道中的子区

用户获取频道中的子区。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/thread/list?channelId={channel_id}

分页获取:

curl -X GET https://{host}/{org_name}/{app_name}/circle/thread/list?channelId={channel_id}&limit={limit}&cursor={cursor}
路径参数

其它参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
channel_id String 子区所属频道的 ID。
limit Int 每页获取的子区数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
threads List 获取到的子区详情列表。
count Int 获取到的子区数量。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/list?channelId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/list?channelId=XXX&limit=1&cursor=XXX'
响应示例
{
  "code" : 200,
  "threads" : [
    {
       "id" : "1895600",
       "msgId" : "198008034121000",
       "channelId" : "156009089",
       "owner" : "user1",
       "created" : 1650856033420
    }
    ],
     "cursor" : "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06ZGlzY29yZDo2MjI0MjEwMiM5MDoy"
}

用户获取频道中加入的子区

用户获取频道中加入的子区。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/thread/joined?userId={user_id}&channelId={channel_id}

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/thread/joined?userId={user_id}&channelId={channel_id}&limit={limit}&cursor={cursor}
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否所需 描述
user_id String 用户 ID。
channel_id String 子区所属频道的 ID。
limit Int 每页获取的子区数量。取值范围为 [1,20],默认值为 20。该参数仅在分页查询时设置。
cursor String 游标,指定下次查询的开始位置。该参数仅在分页查询时设置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 token,格式为 Bearer ${token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
threads List 获取到的子区详情列表。
count Int 获取到的子区数量。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/joined?userId={user_id}&channelId=XXX'

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/joined?userId={user_id}&channelId=XXX&limit=1&cursor=XXX'
响应示例
{
  "code" : 200,
  "threads" : [
    {
        "id" : "1895600",
        "msgId" : "198008034121000",
        "channelId" : "156009089",
        "owner" : "user1",
        "created" : 1650856033420
    }
    ],
     "cursor" : "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06ZGlzY29yZDo2MjI0MjEwMiM5MDoy"
}