创建 PK 之后回调
功能说明
App 后台可以通过该回调实时查看用户创建 Battle 的信息。
注意事项
要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详见 第三方回调配置 文档。
回调的方向是 Live 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
可能触发该回调的场景
App 用户通过客户端创建 battle 成功。
App 管理员通过 REST API 创建 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.CallbackAfterCreateBattle |
contenttype | 固定值为 json |
ClientIP | 客户端 IP，格式如： 127.0.0.1 |
OptPlatform |
请求包示例
{"CallbackCommand": "Live.CallbackAfterCreateBattle","Operator_Account": "brennanli","BattleId": "4siHsNsWN/T3aub9zKraqPbSEGRX2z6gs3LDFi+d/3M=", //battle id"FromRoomId": "pk-3", //发起battle的主叫方房间id"ToRoomIdList": [ //参与battle的被叫方房间id列表"pk-5"],"Timeout": 30000, //如果NeedResponse为true，那么最多等待被叫方处理时长，如果被叫方不处理表示放弃参加battle"Duration": 60000, //battle开启后的时长，单位毫秒"NeedResponse": false, //为false表示直接开始battle,如果为true得等被叫方处理后才能开始battle"ExtensionInfo": "extension pk","EventTime":1739954005000}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令 |
Operator_Account | String | 发起 battle 请求的操作者 UserID |
BattleId | String | PK 对应的 battle id |
FromRoomId | String | battle 的主叫方房间 ID |
ToRoomIdList | Array | 参与 battle 的被叫方房间 ID 列表 |
Timeout | Integer | 创建 battle 后，等待被叫方处理的最大等待时长，单位ms |
Duration | Integer | battle 的时长 |
NeedResponse | Bool | 创建 battle 后是否需要被叫方房主同意加入 |
ExtensionInfo | String | battle 的扩展信息 |
EventTime | Integer | 事件触发的毫秒级别时间戳 |
应答包示例
App 后台同步数据后，发送回调应答包。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // 忽略回调结果}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 必填 | 错误码，此处填0表示忽略应答结果 |
ErrorInfo | String | 必填 | 错误信息 |
参考
第三方回调简介
