房间状态回调
# 人员管理 Server API 功能概述
使用融云音视频服务的开发者可以在 App Server 调用如下接口，来管理进行音视频会话的房间，或参会人员。比如从会话房间中移出指定用户，或禁止指定用户加入任何房间等。
使用场景举例：APP 服务管理员或 APP 运营人员想将某一用户从通话中踢出房间，并在一段时间内不允许再进入音视频会话房间。可先将用户封禁处理，再从指定的聊天室移出。
融云提供的 Server API 功能接口，必须通过 App Server 进行调用，不支持通过客户端直接调用。通过客户端直接调用融云 Server API 接口而引起的问题，融云不负责解决。 在调用 Server API 时，建议不使用 KeepAlive 方式，如有特殊情况需要使用 KeepAlive 建议在此基础上，每个 HTTP 连接使用建议小于 60 秒，断开重连，不要长期复用一个 HTTP 连接，长期使用会导致 API 负载均衡失效，影响故障转移策略。已复制
# 封禁
作用：将某个用户封禁后，此人在封禁时期内不可以再加入任何房间。
方法名：/rtc/user/block.json
签名方法：请参考 通用 API 接口签名规则
URL：http(s): / /rtcapi-cn.ronghub.com/rtc/user/block.json
HTTP 方法：POST
** 表单参数 **
| 名称 | 类型 | 说明 |
|---|---|---|
| userId | String | 被封禁的用户id（必传） |
| minute | Int | 封禁的分钟数,最低是1,最大为43200（必传） |
JSON 格式：
{ "userId":"DDDDD", "minute":1 }已复制
2
3
4
** 返回值 **
| 名称 | 类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
JSON 格式：
{"code":200}已复制
# 解除封禁
作用：对已被封禁的用户，解除封禁。
方法名：/rtc/user/unblock.json
签名方法：请参考 通用 API 接口签名规则
URL：http(s): / /rtcapi-cn.ronghub.com/rtc/user/unblock.json
HTTP 方法：POST
** 表单参数 **
| 名称 | 类型 | 说明 |
|---|---|---|
| userId | String | 被解封的用户id。（必传） |
** 返回值 **
| 名称 | 类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
JSON 格式：
{"code":200}已复制
# 移出用户
作用：把已在房间内的某一用户从当前的房间中移出，只要房间不销毁这个用户不允许再次加入。
方法名：/rtc/user/kick.json
签名方法：请参考 通用 API 接口签名规则
URL：http(s): / /rtcapi-cn.ronghub.com/rtc/user/kick.json
HTTP 方法：POST
** 表单参数 **
| 名称 | 类型 | 说明 |
|---|---|---|
| userId | String | 被踢的用户id（必传） |
| roomId | String | 音视频会话所在房间号 Id。（必传） |
{ "userId":"DDDDD", "roomId":"DXXXX", }已复制
2
3
4
** 返回值 **
| 名称 | 类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。返回值请参考 API 方法返回值说明 |
JSON 格式：
{"code":200}已复制
# 查询房间状态
作用：查询房间创建状态，以及会话id（sessionId），成员列表，以及每个成员发布的音视频流信息。
方法名：/rtc/room/query
签名方法：请参考 通用 API 接口签名规则
URL：http(s): / /rtcapi-cn.ronghub.com/rtc/room/query.json
HTTP 方法：POST
** 表单参数 **
| 名称 | 类型 | 说明 |
|---|---|---|
| roomId | String | 要查询的房间id（必传） |
** 返回值 **
| 名称 | 类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
JSON 格式：
{ "code":200, "roomId":"444", "sessionId":"cRZTAOjBsS8gUZLrTTIO_A", "createTime":1585043771361, "members":[ { "userId":"13811223344_h0fc_web", "joinTime":1585043771362, "data":{ "uris":[ { "mediaType":0, "msid":"13811223344_h0fc_web_RongCloudRTC", "uri":"{\"clusterId\":\"rtc-data-dev-rtc40-15-bdcbj.rongcloud.net\",\"serverId\":\"172.24.151.15:9005\",\"resourceId\":\"13811223344_h0fc_web_RongCloudRTC_0\",\"connectionId\":\"AAY2NjM0NjMAFDEzODExMjIzMzQ0X2gwZmNfd2ViAAM0NDQA\",\"ssrc\":2750434140,\"serviceProvider\":\"awsnx\",\"userTimestamp\":1585043802893}", "tag":"RongCloudRTC", "state":1 }, { "mediaType":1, "msid":"13811223344_h0fc_web_RongCloudRTC", "uri":"{\"clusterId\":\"rtc-data-dev-rtc40-15-bdcbj.rongcloud.net\",\"serverId\":\"172.24.151.15:9005\",\"resourceId\":\"13811223344_h0fc_web_RongCloudRTC_1\",\"connectionId\":\"AAY2NjM0NjMAFDEzODExMjIzMzQ0X2gwZmNfd2ViAAM0NDQA\",\"ssrc\":1782111418,\"serviceProvider\":\"awsnx\",\"userTimestamp\":1585043802893}", "tag":"RongCloudRTC", "state":1 } ] } } ] }已复制
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 错误码
| 错误码 | 英文描述 | 解释 |
|---|---|---|
| 40001 | user id is not in room | 操作的用户已经不在该房间了 |
| 40002 | internal error | 服务器内部错误，可能有很多种，后续会逐个抛离出来，更明确 |
| 40003 | server has no roominfo | 没有该房间 |
| 40004 | userId is Empty | 用户id是空 |
| 40005 | limit error | 房间人数超过限制 |
| 40006 | param error | 请求的参数错误 |
| 40007 | get token error | token编解码错误 |
| 40008 | db error | 暂时没有这个错误的抛出 |
| 40009 | json error | 解析json失败 |
| 40010 | not open voip error | 用户没有开通音视频服务 |
| 40011 | Room type is not created roomType error | 加入房间的类型错误 |
| 40012 | The User have no auth | 用户没有被授权（混合云） |
| 40015 | has no config MCU Address | 没有配置混流地址 |
| 40016 | not allow video broadcast | 不允许开启视频直播 |
| 40017 | not allow audio broadcast | 不允许开启音频直播 |
| 40018 | get token failed | 生成token失败 |
| 40021 | user is blocked | 用户被封禁 |