调用 ListPosterInviteAPI 接口，获取指定直播间的邀请榜单数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListPosterInviteAPI | 接口名称。当前 API 的名称为 ListPosterInviteAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。 |
| PageNo | Integer | 否 | 1 | 分页查询页码，默认值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量，默认值为 10。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TotalItemCount | Integer | 1 | 查询结果总数。 |
| InviteList | Array of InviteList | - | 邀请榜单数据列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| InviterName | String | 观众 A | 分享人昵称。 |
| InviteCount | Integer | 12 | 邀请人数。 |
| UserId | Long | 12****239 | 用户 ID，即分享人在企业直播的唯一标识。 |
| UserTel | String | 152****0000 | 分享人的手机号。 |
ExternalUserId | String |
| 关联用户 ID，即分享人在第三方平台的唯一标识。
说明 如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 |
| Rank | Integer | 1 | 分享人的排名。 |
InviterAvatar | String |
| 分享人的头像地址，包含协议头。 说明 该参数仅用于获取以下场景中的分享人头像地址：
|
GET https://livesaas.volcengineapi.com/?Action=ListPosterInviteAPI&Version=2020-06-01&ActivityId=1779****87158&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": "观众 A", "InviteCount": 12, "UserId": 12****239, "UserTel": "152****0000", "ExternalUserId": "abc", "Rank": 1, "InviterAvatar": "https://user.avatar.com/example" } ] } }