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

文档中心

立即注册

导航

企业直播

获取邀请榜单数据

最近更新时间：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

参数	类型	是否必选	示例值	描述
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&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
    }
}

错误码

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