功能说明
App 后台可以通过该回调及时知晓 battle 开启。
注意事项
要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详见 第三方回调配置 文档。
回调的方向是 Live 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
可能触发该回调的场景
battle 创建后，无需等待直接进入开启状态。
battle 创建后，所有被叫方处理完 battle 请求后或者整体等待时间结束后，只要同意加入 battle 的被叫方房主大于等于1人，battle 正式开始。
回调发生时机
battle 正式开启后。
接口说明
请求 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 | 固定为 Live.CallbackAfterStartBattle。 |
contenttype | 固定值为 json。 |
ClientIP | 客户端 IP，格式如： 127.0.0.1。 |
OptPlatform |
请求包示例
{"CallbackCommand": "Live.CallbackAfterStartBattle","BattleId": "4siHsNsWN/T3aub9zKraqI4zZAyPRpXQhdtKv1q4HOs=", // battle id"Duration": 60000, // battle时长"CreateTime": 1739954005, // battle创建时间, 单位秒"StartTime": 1739954005, // battle开启时间, 单位秒"FromRoomInfo": { // battle 主叫方信息"RoomId": "pk-3","Owner_Account": "brennan"},"ToRoomList": [ // battle 被叫方信息{"RoomId": "pk-5","Owner_Account": "tandy"}],"EventTime":1739954005000 //回调触发时间, 单位毫秒}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令。 |
BattleId | String | battle ID。 |
Duration | Integer | battle 的时长，单位毫秒。 |
CreateTime | Integer | battle 创建时间，Unix 时间戳。 |
StartTime | Integer | battle 开启时间，Unix 时间戳。 |
FromRoomInfo | String | battle 的主叫方信息。 |
ToRoomList | Array | 参与 battle 的被叫方信息。 |
RoomId | String | 房间 ID。 |
Owner_Account | String | 房主账号 ID。 |
EventTime | Integer | 事件触发的毫秒级别时间戳。 |
应答包示例
App 后台同步数据后，发送回调应答包。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 忽略回调结果}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果，OK 表示处理成功，FAIL 表示失败。 |
ErrorInfo | String | 必填 | 错误信息。 |
ErrorCode | Integer | 必填 | 错误码，此处填0表示忽略应答结果。 |
参考
第三方回调简介
