You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取邀请榜单数据

最近更新时间：2023.11.08 09:30:20

首次发布时间：2022.09.09 11:00:31

我的收藏

获取邀请榜单数据。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

  • 请求方式：GET
  • 请求地址：https://livesaas.volcengineapi.com/?Action=ListPosterInviteAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是ListPosterInviteAPI接口名称。当前 API 的名称为 ListPosterInviteAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1779168287158直播间 ID。您可通过ListActivityAPI 接口查询 ID
PageNoInteger否1分页查询页码，默认值为1
PageItemCountInteger否10分页查询数量，默认值为10

返回参数

参数类型示例值描述
TotalItemCountInteger1邀请榜单总数量
InviteListArray of InviteList-观众邀请数据列表

InviteList

参数类型示例值描述
InviterNameString用户名观众昵称
InviteCountInteger12邀请人数
UserIdLong231231用户 ID
UserTelString18800000000用户手机号
ExternalUserIdString自定义 ID自定义用户 ID
RankInteger1排名

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListPosterInviteAPI&Version=2020-06-01&ActivityId=1779168287158&PageItemCount=10&PageNo=1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023101214474981E3207A697D9E21B73D",
        "Action": "ListPosterInviteAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697093269
    },
    "Result": {
        "InviteList": [
            {
                "InviterName":	"用户名",
                "InviteCount":	12,
                "UserId":	231231,
                "UserTel":	"18800000000",
                "ExternalUserId":	"自定义	ID",
                "Rank":	1 
            }
        
        ],
        "TotalItemCount": 1
    }
}

错误码

访问公共错误码获取详细信息。