查询 PK 直播间打赏榜
更新时间: 2023/02/13 02:08:30
通过该接口查询一场 PK 的打赏信息。
接口请求地址
- 请求方法:POST
- URL:http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/rewardTop
- Content-Type:application/json;charset=utf-8
请求参数
- POST 请求中 Header 的设置请参考请求结构描述。
- POST 请求中 Body 的设置如下:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
pkId | String | 必选 | 12345 | PK ID。 |
liveRecordId | String | 必选 | 1 | 直播记录 ID。 |
返回参数
以下是返回结果中 data
属性内包含的参数。
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
rewardTop | Collection | - | 打赏榜信息。 |
rewardCoinTotal | Long | 1297 | 打赏总金额。 |
其中 rewardTop
结构如下:
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
accountId | String | 232403973399296 | 打赏用户的 RTC 账户 ID。 |
imAccid | String | 656564973399296 | 打赏用户的 IM 账户 ID。 |
userName | String | 用户 446983 | 打赏用户的昵称。 |
icon | String | https://yx-web-nosdn.netease.im/XX.jpg |
打赏用户的头像地址。 |
rewardCoin | Long | 999 | 该用户的打赏金额。 |
示例
请求 Body 示例
{
"liveRecordId": 62,
"pkId":"287305064145024"
}
返回示例
{
"code": 200,
"data": {
"rewardTop": [
{
"userUuid": 232403973399296,
"userName": "用户446983",
"icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117833343242240.jpg",
"rewardCoin": 999
},
{
"userUuid": 232403973399296,
"userName": "用户446983",
"icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117783884009472.jpg",
"rewardCoin": 199
},
{
"userUuid": 232403973399296,
"userName": "用户446983",
"icon": "https://yx-web-nosdn.netease.im/quickhtml/assets/yunxin/default/g2-demo-avatar-imgs/86117829270573056.jpg",
"rewardCoin": 99
}
],
"rewardCoinTotal": 1297
},
"requestId": "af245fd202110191056342600060000",
"costTime": "16ms"
}
此文档是否对你有帮助?