功能说明
App 后台可以通过该回调实时查看录制状态变更相关信息。
注意事项
回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
可能触发该回调的场景
App 用户通过客户端开启/停止录制时或房间录制状态发生变化时。
回调发生时机
录制状态变更后触发。
接口说明
请求 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.CallbackAfterRecordingChanged。 |
contenttype | 固定值为: json。 |
ClientIP | 客户端 IP,格式例如:127.0.0.1 |
OptPlatform |
请求包示例
{"CallbackCommand": "Room.CallbackAfterRecordingChanged","EventGroupId": 3,"EventType": 305,"CallbackTs": 1752580150082,"EventInfo": {"RoomId": "635055","EventTs": 1752580150,"EventMsTs": 1752580150081,"UserId": "user1","TaskId": "-m9-bVVU7id***K-m928oZWQndiborbEWH3zY-lIXlprc-gQvQE","Payload": {"Status": 0}}}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令。 |
EventGroupId | Number | 事件组 ID, 云端录制固定为3,页面录制固定为8。 |
EventType | Number | 回调通知的事件类型。 |
CallbackTs | Number | 事件回调服务器向您的服务器发出回调请求的 Unix 时间戳,单位为毫秒。 |
EventInfo | JSON Object |
应答包示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": ""}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果: OK:处理成功。 FAIL:处理失败。 |
ErrorCode | Integer | 必填 | 错误码: 0:处理成功。 非0:处理失败。 |
ErrorInfo | String | 必填 | 错误信息。 |