文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>实时音视频>直播与语聊房（含 UI）>服务端 API>REST API>PK 相关>获取 PK 信息

获取 PK 信息

最近更新时间：2025-03-24 18:05:22

我的收藏

本页目录：

功能说明

App 管理员可以通过该接口获取 pk 详情。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/live_engine_http_pk/get_battle_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
美国：adminapiusa.im.qcloud.com
v4/live_engine_http_pk/get_battle_info
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式
{
     "BattleId":"HuYM036AMk2JJeSUgnv5H0KDJpc+HXfqTAtGuYWzRPs=", //业务后台创建pk时候可以保存好该BattleId。
     "RoomId":"room_pk1" //当业务侧不知道具体的BattleId时候，可以填写RoomId，这样就可以获取该RoomId正在进行的BattleId信息
}


请求包字段说明

字段
类型
属性
说明
BattleId
String
必填
pk 场次的 ID
RoomId
String
选填
房间 ID，当不知道 BattleId 时候，可以填写 RoomId，响应包返回该房间正在进行的 PK 详情

应答包体示例

基础形式
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-e1fffbc751dc44bc95ec960d1fdfbefe-O-Seq-126652",
    "Response": {
        "BattleId": "HuYM036AMk2JJeSUgnv5H0KDJpc+HXfqTAtGuYWzRPs=",
        "Duration": 120000,
        "StartTime": 1739508625,
        "EndTime": 1739508746,
        "Status": 3,
        "FromRoomInfo": {
            "RoomId": "pk-3",
            "Score": 100,
            "Owner_Account": "brennanli1"
        },
        "ToRoomList": [
            {
                "RoomId": "pk-4",
                "Score": 100,
                "Owner_Account": "brennanli2"
            }
        ]
    }
}

应答包字段说明

字段
类型
说明
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId
BattleId
String
pk ID
Duration
Integer
pk 时长
StartTime
Integer
pk 正式开始时间
EndTime
Integer
pk 正式结束时间
Status
Integer
pk 状态，1表示未开始，2表示进行中，3表示已结束，4表示 pk 未开始就结束
FromRoomInfo
Object
pk 主叫房间信息
ToRoomList
Array
pk 被叫房间信息
RoomId
String
房间 ID
Score
Integer
pk 中的房间分数
Owner_Account
String
pk 中的房间对应的房主账号 ID

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试
100002
请参数非法，请根据错误描述检查请求是否正确
100411
当前pk不存在，或者结束时间过长信息已被清理
中国站
目录