环信超级社区的社区 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:社区管理员;
- 2:社区的普通成员。

响应参数

参数 类型 描述
name String 社区名称。
owner String 社区的所有者。
description String 社区描述。
custom String 社区的扩展信息。
icon_url String 社区头像的 URL。
server_tag_id String 社区标签 ID。
tag_name String 社区标签名称。
tag_count Int 社区标签数量。
server_id String 社区 ID。
default_channel_id String 社区的默认频道的 ID。
user_id String 环信用户 ID。
role Int 社区成员的角色:
- 0:社区所有者;
- 1:社区管理员;
- 2:社区的普通成员。
created Long 社区的创建时间,Unix 时间戳,单位为毫秒。

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

Authorization:Bearer ${YourToken}

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

查询环信超级社区用户是否存在

查询环信超级社区用户是否存在。

HTTP 请求

GET https://{host}/{orgName}/{appName}/circle/user/{user_id}
路径参数

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

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

HTTP 响应

响应 body

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

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

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

示例

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

创建社区

创建一个社区并设置社区名称、社区头像的 URL、社区描述和社区扩展信息。

每个用户最多可以创建 100 个社区。

HTTP 请求

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

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

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。
请求 body
参数 类型 是否必需 备注
owner String 社区创建者(即社区所有者)的用户 ID,长度不能超过 64 字节。
name String 社区名称,长度不能超过 50 个字符。
icon_url String 社区头像的 URL,长度不能超过 500 个字符。
description String 社区描述,长度不能超过 500 个字符。
custom String 社区的扩展信息,例如,你可以给社区添加业务相关的标记,长度不能超过 500 个字符。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
server_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/server' -d '{
 "owner" : "user1",
 "name" : "server",
 "icon_url" : "http://circle.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
 "description" : "community",
 "custom" : "custom"
}'
响应示例
{
    "code": 200,
    "server_id": "19VM9oPBasxxxxxx0tvWViEsdM"
}

修改社区信息

修改指定社区的信息。你可以修改社区名称、社区头像的 URL、社区描述和社区的扩展信息。

HTTP 请求

PUT https://{host}/{org_name}/{app_name}/circle/server/{server_id} 
路径参数

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

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。
请求 body
参数 类型 是否必需 备注
name String 社区名称,长度不能超过 50 个字符。
icon_url String 社区头像的 URL,长度不能超过 500 个字符。
description String 社区描述,长度不能超过 500 个字符。
custom String 社区的扩展信息,例如,可以给社区添加业务相关的标记,长度不能超过 500 个字符。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
server 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/server/XXX' -d '{
 "name" : "easemob",
 "icon_url" : "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
 "description" : "community",
 "custom" : ""custom"
}'
响应示例
{
    "code": 200,
    "server": {
        "name": "easemob",
        "owner": "u1",
        "description": "community",
        "custom": "custom",
        "tags": [
            {
                "server_tag_id": "1",
                "tag_name": "社交"
            }
        ],
        "tag_count": 1,
        "created": 1658126097514,
        "server_id": "19SW5Q85jHxxxxx6T5kexvn",
        "icon_url": "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
        "default_channel_id": "187xxxx09"
    }
}

为指定社区添加标签

每个社区最多可以添加 10 个标签。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/server/{server_id}/tag/add
路径参数

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

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。
请求 body
参数 类型 是否必需 备注
tags List 为社区添加标签的数组,最多可以添加 10 个标签,每个标签的长度不能超过 20 个字符。

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/server/XXX/tag/add' -d '{
 "tags": ["社交"]
}'
响应示例
{
    "code": 200,
    "tags": [
        {
            "server_tag_id": "1",
            "tag_name": "社交"
        }
    ]
}

获取社区标签

获取指定社区的标签。

HTTP 请求

GET https://{host}/{orgName}/{appName}/circle/server/{server_id}/tag
路径参数

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

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

HTTP 响应

响应 body

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

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

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourToken>' 'http://XXX/XXX/XXX/circle/server/XXX/tag'
响应示例
{
    "code": 200,
    "count": 1,
    "tags": [
        {
            "server_tag_id": "78",
            "tag_name": "uur2"
        }
    ]
}

移除指定社区的标签

根据标签的 ID 移除标签,不能使用标签名进行移除。移除标签之前,你可以通过获取社区详情获取标签 ID。

HTTP 请求

POST https://{host}/{org_name}/{app_name}/circle/server/{server_id}/tag/remove
路径参数

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

请求 header
参数 类型 是否必需 描述
Content-Type String 内容类型。请填 application/json
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。
请求 body
参数 类型 是否必需 备注
tagIds List 要移除的社区标签 ID 的数组,一次移除的标签不能超过 10 个。

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/server/XXX/tag/remove' -d '{
 "tagIds" : ["1", "2"]
}'
响应示例
{
    "code": 200
}

搜索社区

你可以根据社区名称搜索社区,一次最多可查找出 15 个社区。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/server/search?name={name} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
name String 社区名称。社区名称不能超过 50 个字符。需输入完整的社区名称,不支持模糊搜索。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
servers List 搜索到的社区详情。
count Int 搜索到的社区数量。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/server/search?name=XXX'
响应示例
{
    "code": 200,
    "count": 1,
    "servers": [
        {
          "name": "easemob",
          "owner": "u1",
          "description": "community",
          "custom": "custom",
          "tags": [
              {
                  "server_tag_id": "1",
                  "tag_name": "社交"
              }
          ],
          "tag_count": 1,
          "created": 1658126097514,
          "server_id": "19SW5Q85jHxxxxx6T5kexvn",
          "icon_url": "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
          "default_channel_id": "187xxxx09"
        }
    ]
}

获取指定社区的详情

获取指定社区的详情。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/server/{server_id}/by-id
路径参数

参数及描述详见公共参数

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

HTTP 响应

响应 body

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

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

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/server/XXX/by-id'
响应示例
{
    "code": 200,
    "server": {
        "name": "easemob",
        "owner": "u1",
        "description": "community",
        "custom": "custom",
        "tags": [
            {
                "server_tag_id": "1",
                "tag_name": "社交"
            }
        ],
        "tag_count": 1,
        "created": 1658126097514,
        "server_id": "19SW5Q85jHxxxxx6T5kexvn",
        "icon_url": "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
        "default_channel_id": "187xxxx09"
    }
}

获取推荐的社区的详情

目前,该方法返回最新创建的 5 个社区的详情。若社区数量少于 5 个,则返回实际的社区数量。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/server/recommend/list
路径参数

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

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

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
servers List 推荐的社区详情。
count Int 推荐的社区数量。

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

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/server/recommend/list'
响应示例
{
    "code": 200,
    "count": 1,
    "servers": [
        {
          "name": "easemob",
          "owner": "u1",
          "description": "community",
          "custom": "custom",
          "tags": [
              {
                  "server_tag_id": "1",
                  "tag_name": "社交"
              }
          ],
          "tag_count": 1,
          "created": 1658126097514,
          "server_id": "19SW5Q85jHxxxxx6T5kexvn",
          "icon_url": "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
          "default_channel_id": "187xxxx09"
        }
    ]
}

获取当前用户加入的社区的详情

获取当前用户加入的社区的详情。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/server/list?userId={user_id} 

分页获取:

GET https://{host}/{org_name}/{app_name}/circle/server/list?userId={user_id}&limit={limit}&cursor={cursor} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
user_id String 用户 ID。
limit Int 每页期望获取的社区数量。
cursor String 游标,下次数据查询的起始位置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
count Int 获取到的社区数量。
servers List 获取到的社区详情。
cursor String 游标,下次数据查询的起始位置。

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

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

示例

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

分页获取:

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/server/list?userId=XXX&limit=1&cursor=XXX'
响应示例
{
    "code": 200,
    "count": 1,
    "servers": [
        {
          "name": "easemob",
          "owner": "u1",
          "description": "community",
          "custom": "custom",
          "tags": [
              {
                  "server_tag_id": "1",
                  "tag_name": "社交"
              }
          ],
          "tag_count": 1,
          "created": 1658126097514,
          "server_id": "19SW5Q85jHxxxxx6T5kexvn",
          "icon_url": "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
          "default_channel_id": "187xxxx09"
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

删除社区

删除指定的社区。删除社区后,该社区中的频道也将被删除。

HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/circle/server/{server_id}
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App 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/server/XXX'
响应示例
{
    "code": 200
}

获取社区成员列表

获取社区成员列表。

HTTP 请求

获取第一页:

GET https://{host}/{org_name}/{app_name}/circle/server/{server_id}/users 

分页获取:

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

参数及描述详见 公共参数

查询参数
参数 类型 是否必需 描述
limit Int 每页期望获取的社区成员数量。
cursor String 游标,下次数据查询的起始位置。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
count Int 获取到的社区成员数量。
users List 获取到的社区成员详情。
cursor String 游标,下次数据查询的起始位置。

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

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

示例

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

分页获取:

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

将用户加入社区

将单个用户加入社区,每个用户最多加入 100 个社区。

HTTP 请求

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

参数及描述详见公共参数

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

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
server JSON 用户加入的社区的详情。

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

示例

请求示例
将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/server/XXX/join?userId=XXX'
响应示例
{
    "code": 200,
    "server": {
        "name": "easemob",
        "owner": "u1",
        "description": "community",
        "custom": "custom",
        "tags": [
            {
                "server_tag_id": "1",
                "tag_name": "社交"
            }
        ],
        "tag_count": 1,
        "created": 1658126097514,
        "server_id": "19SW5Q85jHxxxxx6T5kexvn",
        "icon_url": "http://discord.oss/19b1d7b0-7079-11e9-9bd8-25c5e81b42a1",
        "default_channel_id": "187xxxx09"
    }
}

查询用户是否在社区内

查询用户是否在社区内。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/server/{server_id}/user/{user_id} 
路径参数

参数及描述详见公共参数

请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App 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/server/XXX/user/XXX'
响应示例
{
    "code": 200,
    "result": true
}

查询指定成员在社区内的角色

查询指定成员在社区内的角色。

HTTP 请求

GET https://{host}/{org_name}/{app_name}/circle/server/{server_id}/user/role?userId={user_id} 
路径参数

参数及描述详见公共参数

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

HTTP 响应

响应 body

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

字段 类型 描述
code Int 环信超级社区的服务状态码。
role Int 社区成员角色:
- 0:社区所有者;
- 1:社区管理员;
- 2:社区的普通成员。

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

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

示例

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

修改社区中指定成员的角色

修改社区中指定成员的角色。

HTTP 请求

PUT https://{host}/{org_name}/{app_name}/circle/server/{server_id}/user/role?userId={user_id}&role={role} 
路径参数

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
user_id String 用户 ID。
role Int 要修改的成员角色,只能传以下值:
- 1:表示社区管理员;
- 2:表示普通成员。
若传 0(表示社区所有者)或其他无效值时会报错。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourApp Token},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App Token 值。

HTTP 响应

响应 body

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

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

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

示例

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

将成员移出社区

将指定成员移出社区。一旦成员被移出社区,该成员会自动被移出该社区下的所有频道。

HTTP 请求

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

参数及描述详见公共参数

查询参数
参数 类型 是否必需 描述
user_id String 用户 ID。
请求 header
参数 类型 是否必需 描述
Accept String 内容类型。请填 application/json
Authorization String 该管理员的鉴权 App Token,格式为 Bearer ${YourAppToken},其中 Bearer 是固定字符,后面加英文空格,再加获取到的 App 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/server/XXX/user/remove?userId=XXX'
响应示例
{
    "code": 200
}