发起 PK
功能说明
App 管理员可以通过该接口发起 pk。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_pk/create_battle?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明。
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com |
v4/live_engine_http_pk/create_battle | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
{"FromRoomId":"pk-1", //pk的主叫房间id"ToRoomIdList":["pk-2","pk-3"], //pk的被叫房间id列表"Duration":60000, //pk时长"ExtensionInfo":"extension pk"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
FromRoomId | String | 必填 | pk 主叫房间 ID |
ToRoomIdList | String | 必填 | pk 被叫房间 ID 列表 |
Duration | Integer | 必填 | pk 时长 |
ExtensionInfo | String | 选填 | pk 信息扩展字段 |
注意：
发起 pk 时候，业务侧需要确认端上房间处于连线中，发起 pk 的时候会通知参与 pk 的房间房主。
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "requestId-123-456","Response":{"BattleId": "battleid1","Result": [{"RoomId": "pk-2",// 0 表示发起成功，// 3 表示已经处于其他pk中,// 5 系统错误"ResultCode": 0,"ResultMessage": "",},{"RoomId": "pk-3","ResultCode": 0,"ResultMessage": "",}],}}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败 |
ErrorInfo | String | 错误信息 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
RequestId | String | 唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId |
BattleId | String | 此次 pk 的 ID |
Result | Array | 被叫的 pk 情况 |
RoomId | String | 房间 ID |
ResultCode | Integer | 结果，0表示成功， 3表示正处于 pk 中，5表示系统错误 |
ResultMessage | String | pk 结果信息 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
100001 | 服务器内部错误，请重试 |
100002 | 请参数非法，请根据错误描述检查请求是否正确 |
100003 | 房间 ID 已存在，请选择其他房间 ID |
100412 | 被叫房间都处于 pk 中，请稍后再试 |
100415 | 主叫方处于 pk 中，请稍后再试 |
