设置 PK 分数
功能说明
App 管理员可以通过该接口设置 pk 里各房间分数。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_pk/set_battle_score?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/set_battle_score | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
{"BattleId":"HuYM036AMk2JJeSUgnv5H0KDJpc+HXfqTAtGuYWzRPs=","OpType":1,"ScoreList":[{"RoomId":"pk-live1","Score":100},{"RoomId":"pk-live2","Score":100}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
BattleId | String | 必填 | pk 场次对应的 ID,可通过获取 pk 详情获取到 |
OpType | String | 必填 | 设置类型,1为累加,2为覆盖设置 |
ScoreList | Array | 必填 | 设置分数列表 |
RoomId | String | 必填 | 房间 ID |
Score | Integer | 必填 | 房间对应的分数 |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-e7625183568d4058bd48c9924d4b1ed7-O-Seq-125382","Response": {"Result": [{"RoomId": "pk-3","ResultCode": 0},{"RoomId": "pk-4","ResultCode": 0}]}}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
RequestId | String | 唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId |
Result | Array | 设置 battle 分数的总结果 |
RoomId | String | 房间 ID |
ResultCode | Integer | 0表示成功,1表示房间不存在 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试 |
100002 | 请参数非法,请根据错误描述检查请求是否正确 |
100006 | 当前 pk 尚未开始或者已经结束,无权再设置分数 |