功能说明
App 后台可以通过该回调实时查看用户创建房间的信息,包括:App 后台有房间创建成功通知时,可以据此进行数据同步等操作。
注意事项
要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详见 第三方回调配置 文档。
回调的方向是 Room 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
可能触发该回调的场景
App 用户通过客户端创建房间成功
App 管理员通过 REST API 创建房间成功
回调发生时机
房间创建成功之后。
接口说明
请求 URL 示例
以下示例中 App 配置的回调 URL 为
https://www.example.com
。
示例:https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
请求参数说明
参数 | 说明 |
https | 请求协议为 HTTPS,请求方式为 POST |
www.example.com | 回调 URL |
SdkAppid | 创建应用时在即时通信 IM 控制台分配的 SDKAppID |
CallbackCommand | 固定为 Room.CallbackAfterCreateRoom |
contenttype | 固定值为 JSON |
ClientIP | 客户端 IP,格式如:127.0.0.1 |
OptPlatform |
请求包示例
{"CallbackCommand":"Room.CallbackAfterCreateRoom","Operator_Account":"admin","RoomInfo":{"RoomId":"tandy-test-rest","RoomName":"tandy-test-rest","RoomType":"Meeting","Owner_Account":"user3","MaxMemberCount":300,"MaxSeatCount":16,"IsVideoDisabled":true,"IsAudioDisabled":true,"IsMessageDisabled":true,"IsScreenSharingDisabled":true,"IsCloudRecordingDisabled":true,"CustomInfo":"custom123","ScheduleStartTime":1703589922,"ScheduleEndTime":1703593522,"RoomStatus":"Running","IsSeatEnabled":true,"TakeSeatMode":"ApplyToTake","CreateTime":1703589922},"ScheduleInviteeList_Account":["user2", "user3", "user3"],"EventTime":1703589922780}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令 |
Operator_Account | String | 发起创建群组请求的操作者 UserID |
RoomId | String | 房间 ID |
RoomName | String | 房间名称 |
RoomType | String | 房间类型:Meeting(会议房间) |
Owner_Account | String | 房主 ID |
MaxMemberCount | Integer | 最大房间成员数量 |
ScheduleStartTime | Integer | 预定会议开始时间 |
ScheduleStartTime | Integer | 预定会议结束时间 |
IsVideoDisabled | Bool | 全体禁画 |
IsAudioDisabled | Bool | 全体禁音 |
IsMessageDisabled | Bool | 禁止所有成员发文本消息 |
IsScreenSharingDisabled | Bool | 禁止屏幕共享 |
IsCloudRecordingDisabled | Bool | 禁止云录制 |
CustomInfo | String | 自定义字段 |
RoomStatus | String | 房间状态: None(关闭) NotStarted(待开始) Running(进行中) |
IsSeatEnabled | Bool | 是否支持麦位 |
MaxSeatCount | Integer | 最大麦位数 |
TakeSeatMode | String | 麦位模式: None(关闭) FreeToTake(自由上麦) ApplyToTake(申请上麦) |
CreateTime | Integer | 预定会议开始时间 |
EventTime | Integer | 事件触发的毫秒级别时间戳 |
应答包示例
App 后台同步数据后,发送回调应答包。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 忽略回调结果}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果: OK:表示处理成功 FAIL:表示失败 |
ErrorCode | Integer | 必填 | 错误码,此处填0表示忽略应答结果 |
ErrorInfo | String | 必填 | 错误信息 |
参考
第三方回调简介
REST API:创建房间