查询 PK 信息

更新时间: 2023/02/13 02:08:30

通过该接口查询一场 PK 的详细信息。

接口请求地址

  • 请求方法:POST
  • URL:http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/info
  • Content-Type:application/json;charset=utf-8

请求参数

  • POST 请求中 Header 的设置请参考请求结构描述。
  • POST 请求中 Body 的设置如下:
参数名称 类型 是否必选 示例 描述
pkId String 必选 12345 PK ID。
liveRecordId String 必选 1 直播记录 ID。

返回参数

以下是返回结果中 data 属性内包含的参数。

参数 类型 示例 描述
appId Long 19 应用 ID。
pkId String 202110191045129500060000 PK ID。
status Integer 1 PK 状态。
countDown Long 147 倒计时剩余时间。单位为秒(s)。
PK 中表示 PK 倒计时剩余时间。
惩罚环节中表示惩罚倒计时剩余时间。
pkStartTime Long 1634611514417 PK 开始时间。
pkEndTime Long 0 PK 结束时间。
inviter Object - 发起 PK 邀请的主播信息。详细信息请参考 inviter 结构
invitee Object - 接受 PK 邀请的主播信息。详细信息请参考 invitee 结构
inviterReward Object - 发起 PK 邀请的主播的打赏信息。详细信息请参考 inviterReward 结构
inviteeReward Object - 接受 PK 邀请的主播的打赏信息。详细信息请参考 inviteeReward 结构

示例

请求 Body 示例

{
    "liveRecordId": 62,
    "pkId":"287305064145024"
}

返回示例

{
    "code": 200,
    "data": {
        "appId": 19,
        "pkId": "202110191045129500060000",
        "status": 1,
        "countDown": 147,
        "pkStartTime": 1634611514417,
        "pkEndTime": 0,
        "inviter": {
            "roomUuid": "238251192348598272",
            "rtcUid": 232403973399296,
            "userUuid": 232403973399296,
            "userName": "用户446983",
            "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117826145816576.jpg",
            "rewardTotal": 1297
        },
        "invitee": {
            "roomUuid": "238251197356597248",
            "rtcUid": 232404007056128,
            "userUuid": "232404007056128",
            "userName": "用户672485",
            "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117870337003520.jpg",
            "rewardTotal": 1297
        },
        "inviterReward": {
            "rewardTop": [
                {
                    "userUuid": 232403973399296,
                    "userName": "用户446983",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117865660354560.jpg",
                    "rewardCoin": 999
                },
                {
                    "userUuid": 232403973399296,
                    "userName": "用户446983",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117839563395072.jpg",
                    "rewardCoin": 199
                },
                {
                    "userUuid": 232403973399296,
                    "userName": "用户446983",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117813671956480.jpg",
                    "rewardCoin": 99
                }
            ],
            "rewardCoinTotal": 1297
        },
        "inviteeReward": {
            "rewardTop": [
                {
                    "userUuid": 232403973399296,
                    "userName": "用户446983",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117881313497088.jpg",
                    "rewardCoin": 999
                },
                {
                    "userUuid": 232403973399296,
                    "userName": "用户446983",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117878641725440.jpg",
                    "rewardCoin": 199
                },
                {
                    "userUuid": 232403973399296,
                    "userName": "用户446983",
                    "icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117824489066496.jpg",
                    "rewardCoin": 99
                }
            ],
            "rewardCoinTotal": 1297
        }
    },
    "requestId": "af245fd202110191045179820060000",
    "costTime": "18ms"
}
此文档是否对你有帮助?
有帮助
去反馈
  • 接口请求地址
  • 请求参数
  • 返回参数
  • 示例
  • 请求 Body 示例
  • 返回示例