ListPosterInviteAPI - 获取邀请榜单数据--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListPosterInviteAPI - 获取邀请榜单数据

最近更新时间：2025.03.24 16:50:54首次发布时间：2022.09.09 11:00:31

获取邀请榜单数据。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的数据统计 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPosterInviteAPI`	接口名称。当前 API 的名称为 `ListPosterInviteAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1779168287158`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PageNo	Integer	否	`1`	分页查询页码，默认值为1
PageItemCount	Integer	否	`10`	分页查询数量，默认值为10

返回参数

参数	类型	示例值	描述
TotalItemCount	Integer	`1`	邀请榜单总数量
InviteList	Array of InviteList	`-`	观众邀请数据列表

InviteList

参数	类型	示例值	描述
InviterName	String	`用户名`	观众昵称
InviteCount	Integer	`12`	邀请人数
UserId	Long	`231231`	用户 ID
UserTel	String	`18800000000`	用户手机号
ExternalUserId	String	`自定义 ID`	自定义用户 ID
Rank	Integer	`1`	排名

请求示例

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

返回示例

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

错误码

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