管理频道以及频道成员

频道（Channel）是一个社区下不同子话题的讨论分区，因此一个社区下可以有多个频道。社区创建时会自动创建默认频道，该频道中添加了所有社区成员，用于承载各种系统通知。从可见性角度看，频道社区分为公开和私密频道；从功能角度看，频道分为文字频道和语聊频道。用户可以根据自己需求创建频道。

超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：

1. 在环信控制台或者调用 RESTful API 或者通过客户端删除群组或聊天室、群组或聊天室加人、踢人等操作时请谨慎操作，需确保操作的群组或者聊天室不是超级社区使用的。
2. 如果将超级社区使用的频道对应的群组或者聊天室删除，会出现数据不一致情况，导致用户加入不了社区、频道、在频道内发不了消息等情况发生。
3. 在清理群组或者聊天室数据时，需先确认要删除的群组 ID 或聊天室 ID 与超级社区的频道 ID 是否一致。你可以调用获取频道详情 API 确认要删除的群组或聊天室是否为超级社区的频道。如果是，请不要进行删除。
4. 如果需要清理超级社区数据，需调用删除社区和删除频道等 API。

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

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

对于分页获取数据列表，若查询参数中的 limit 和 cursor 均未设置，则服务器返回首页的数据列表。

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

Authorization：Bearer ${YourAppToken}

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

每个社区最多可以创建 100 个频道。一个频道只能加入一个频道分组。

POST https://{host}/{org_name}/{app_name}/circle/channel

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

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

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

创建 IM 频道：

将 <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" : "chat channel",
    "type" : 0,
    "mode"：0,
    "max_users" : 200,
    "description" : "chat Channel",
    "custom" : "custom"
}'

创建语聊房频道：

将 <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" : "19KM9oPBasxxxxxx0tvWViVhgk",
    "name" : "voice chatroom channel",
    "type" : 0,
    "mode"：1,
    "max_users" : 10,
    "description" : "voice chatroom Channel",
    "custom" : "custom",
    "rtc_name" : "150986"
}'

创建 IM 频道的响应：

{
    "code": 200,
    "channel": {
        "owner": "user1",
        "name": "chat channel",
        "type": 0,
        "mode": 0,
        "description": "chat channel",
        "custom": "custom",
        "created": 1675845650856,
        "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        "channel_category_id": "77a9860xxxxxx2b54881025861c",
        "channel_id": "2059xxxxxx1542",
        "max_users": 200,
        "default_channel": 0
    },
    "channel_id": "2059xxxxxx1542"
}

创建语聊房频道的响应：

{
    "code": 200,
    "channel": {
        "owner": "user1",
        "name": "voice chatroom Channel",
        "type": 0,
        "mode": 1,
        "description": "voice chatroom Channel",
        "custom": "custom",
        "created": 1675845650856,
        "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        "channel_category_id": "77a9860xxxxxx2b54881025861c",
        "channel_id": "2059xxxxxx1590",
        "max_users": 10,
        "rtc_name" : "150986",
        "default_channel": 0
    },
    "channel_id": "2059xxxxxx1590"
}

修改指定频道的信息。

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

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

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

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

如果返回的 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" : "chat channel",
 		"max_users" : 200,
 		"description" : "chat Channel",
  	"custom" : "custom"
}'

{
    "code": 200,
    "channel": {
        "owner": "user1",
        "name": "chat channel",
        "type": 0,
        "mode": 0,
        "description": "chat channel",
        "custom": "custom",
        "created": 1675845650856,
        "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        "channel_category_id": "77a9860xxxxxx2b54881025861c",
        "channel_id": "2059xxxxxx1542",
        "max_users": 200,
        "default_channel": 0
    }
}

查询指定的频道详情。

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

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

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

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

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

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

查询 IM 频道的响应：

{
    "code": 200,
    "channel": {
        "owner": "user1",
        "name": "chat channel",
        "type": 0,
        "mode": 0,
        "description": "chat channel",
        "custom": "custom",
        "created": 1675845650856,
        "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        "channel_category_id": "77a9860xxxxxx2b54881025861c",
        "channel_id": "2059xxxxxx1542",
        "max_users": 200,
        "default_channel": 0
    }
}

查询语聊房频道的响应：

{
    "code": 200,
    "channel": {
        "owner": "user1",
        "name": "voice chatroom channel",
        "type": 0,
        "mode": 1,
        "description": "voice chatroom channel",
        "custom": "custom",
        "created": 1675845650856,
        "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        "channel_category_id": "77a9860xxxxxx2b54881025861c",
        "channel_id": "2059xxxxxx1542",
        "rtc_name" : "150986",
        "max_users": 10,
        "current_users_count" : 2,
        "default_channel": 0
    }
}

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

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

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
    "code": 200,
    "count": 1,
    "channels": [
        {
            "owner": "user1",
        		"name": "chat channel",
        		"type": 0,
        		"mode": 0,
        		"description": "chat channel",
        		"custom": "custom",
        		"created": 1675845650856,
        		"server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        		"channel_category_id": "77a9860xxxxxx2b54881025861c",
        		"channel_id": "2059xxxxxx1542",
        		"max_users": 200,
        		"default_channel": 0
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

查询用户在社区创建的频道列表。

GET https://{host}/{org_name}/{app_name}/circle/channel/user/{user_id}/created/channels?serverId={server_id}&limit={limit}&cursor={cursor}

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

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

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

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

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/channel/user/XXX/created/channels?serverId=XXX&limit=1&cursor=XXX'

{
    "code": 200,
    "count": 1,
    "channels": [
        {
            "owner": "user1",
            "name": "chat channel",
            "type": 0,
            "mode": 0,
            "description": "chat channel",
            "custom": "custom",
            "created": 1675845650856,
            "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
            "channel_category_id": "77a9860xxxxxx2b54881025861c",
            "channel_id": "2059xxxxxx1542",
            "max_users": 200,
            "default_channel": 0
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

分页获取单个用户已加入的频道列表，包括公开和私密频道。

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

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
    "code": 200,
    "count": 1,
    "channels": [
        {
            "owner": "user1",
        		"name": "chat channel",
        		"type": 0,
        		"mode": 0,
        		"description": "chat channel",
        		"custom": "custom",
        		"created": 1675845650856,
        		"server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        		"channel_category_id": "77a9860xxxxxx2b54881025861c",
        		"channel_id": "2059xxxxxx1542",
        		"max_users": 200,
        		"default_channel": 0
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

分页获取单个社区下的所有私密频道。

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

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
    "code": 200,
    "count": 1,
    "channels": [
        {
            "owner": "user1",
        		"name": "private chat channel",
        		"type": 1,
        		"mode": 0,
        		"description": "private chat channel",
        		"custom": "custom",
        		"created": 1675845650856,
        		"server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        		"channel_category_id": "77a9860xxxxxx2b54881025861c",
        		"channel_id": "2065xxxxxx1590",
        		"max_users": 100,
        		"default_channel": 0
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

删除指定的频道。

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

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

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

如果返回的 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。

POST https://{host}/{org_name}/{app_name}/circle/reaction/user/{user_id}

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

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

如果返回的 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" : "message123456"
}'

{
  "code" : 200,
  "reaction_id" : "15890012560"
}

获取指定消息的 Reaction。

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

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

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

如果返回的 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。

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

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

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

如果返回的 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
}

将用户加入频道。

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

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

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

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

如果返回的 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": {
        "owner": "user1",
        "name": "chat channel",
        "type": 0,
        "mode": 0,
        "description": "chat channel",
        "custom": "custom",
        "created": 1675845650856,
        "server_id": "19VM9oPBasxxxxxx0tvWViEsdM",
        "channel_category_id": "77a9860xxxxxx2b54881025861c",
        "channel_id": "2059xxxxxx1542",
        "max_users": 200,
        "default_channel": 0
    }
}

将指定成员移出频道。

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

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

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

如果返回的 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
}

一次移除多名频道成员。如果所有被移除用户均不是频道成员，则移除失败，并返回错误。移除后，这些成员也会被移除其在该频道中加入的子区。

单个请求最多可移除 20 个频道成员。

POST https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/users/remove

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

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

如果返回的 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/users/remove'
-d '{
    "server_id" : "19VM9oPBasxxxxxx0tvWViEsdM",
    "usernames" : [
    	"u1",
    	"u3",
    	"u5"
    ]
}'

{
    "code": 200,
    "data": [
        {
            "user": "u1",
            "result": true
        },
        {
            "user": "u5",
            "result": true
        },
        {
            "user": "u3",
            "result": true
        }
    ]
}

查询用户是否在频道中。

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

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

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

如果返回的 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
}

查询频道中指定成员的社区角色。社区角色包社区所有者、管理员和普通成员。

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

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

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

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

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

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

{
    "code": 200,
    "role": 2
}

获取指定频道的成员列表：

• 创建语聊频道时，创建者不加入频道。因此，频道创建者不算入频道成员数量，查询频道成员列表时不返回频道创建者。
• 创建文字频道时，创建者直接加入频道。因此，频道创建者算入频道成员数量，查询频道成员列表返回频道创建者。

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

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
    "code": 200,
    "count": 1,
    "users": [
        {
            "user_id" : "user1",
            "role" : 0
        }
    ],
    "cursor": "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aXXXXXXXXXXXXXX"
}

获取频道的禁言列表。

GET https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/mute/list?serverId={server_id}&limit={limit}&cursor={cursor}

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
  "code" : 200,
  "count" : 2,
  "mute_users" : [
    {
      "expire" : 86400000,
      "user" : "u1"
    },
    {
      "expire" : 86400000,
      "user" : "u2"
    }
  ]
}

将成员加入频道禁言列表。成员被禁言后，将无法在频道中发送消息。

POST https://{host}/{org_name}/{app_name}/circle/channel/{channel_id}/user/mute

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

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

如果返回的 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
}

将成员移出频道禁言列表。成员被解除禁言后，可以在频道中发送消息。

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

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

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

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

如果返回的 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
}

创建子区。

POST https://{host}/{org_name}/{app_name}/circle/thread

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

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

如果返回的 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"
}

修改指定子区的信息。

PUT https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}

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

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

如果返回的 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
}

查询指定子区的详情。

GET https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}

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

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

如果返回的 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
}

删除指定的子区。

DELETE https://{host}/{org_name}/{app_name}/circle/thread/{thread_id}

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

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

如果返回的 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
}

加入指定的子区。

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

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

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

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

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX/user/join?userId=XXX'

{
  "code" : 200
}

将成员移出指定的子区。

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

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

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

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

将 <YourAppToken> 替换为你在服务端生成的 App Token
curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXX/XXX/XXX/circle/thread/XXX/user/remove?userId=XXX'

{
  "code" : 200
}

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

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
  "code" : 200,
  "threads" : [
    {
      "id" : "1895600",
      "msgId" : "198008034121000",
      "channelId" : "156009089",
      "owner" : "user1",
      "created" : 1650856033420
    }
    ],
     "cursor" : "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06ZGlzY29yZDo2MjI0MjEwMiM5MDoy"
}

分页获取频道中的子区。

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
  "code" : 200,
  "threads" : [
    {
       "id" : "1895600",
       "msgId" : "198008034121000",
       "channelId" : "156009089",
       "owner" : "user1",
       "created" : 1650856033420
    }
    ],
     "cursor" : "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06ZGlzY29yZDo2MjI0MjEwMiM5MDoy"
}

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

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

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

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

如果返回的 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&limit=1&cursor=XXX'

{
  "code" : 200,
  "threads" : [
    {
        "id" : "1895600",
        "msgId" : "198008034121000",
        "channelId" : "156009089",
        "owner" : "user1",
        "created" : 1650856033420
    }
    ],
     "cursor" : "ZGNiMjRmNGY1YjczYjlhYTNkYjk1MDY2YmEyNzFmODQ6aW06ZGlzY29yZDo2MjI0MjEwMiM5MDoy"
}