调用 GetInviterToken 接口，获取直播间指定分享人的专属 Token。您可将获取的 Token 拼接到 iframe 的嵌入链接中，从而统计 iframe 嵌入场景的分享人和邀请人数。

使用说明 #

在通过 iframe 将企业直播的观看页嵌入您的自有页面时，观看页的分享链接中不包含分享人的专属 Token，因此无法统计分享人和邀请人数。
如需统计分享人和邀请人数，您可以完成以下操作：

1. 调用 UpdateViewingRestriction 接口，将观看限制或评论限制设置为自定义。

   说明

   如果将评论限制设置为自定义，则分享人必须先完成自定义登录，才能分享带有专属 Token 的观看地址。

2. 调用该接口，获取分享人的专属 Token。
3. 在 iframe 的嵌入链接中，拼接 inviter_token=分享人的专属 Token。

例如，观众 A 将观看页分享给观众 B，观众 B 打开的观看页地址为 https://live.byteoc.com/5528/37****9?inviter_token=TOKEN。如果观众 B 是首次进入并登录的当前直播间，则观众 A 为 观众 B 的分享人，观众 A 的邀请人数增加 1 人。

注意事项 #

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

请求说明 #

• 请求方式：GET
• 请求地址：https://livesaas.volcengineapi.com/?Action=GetInviterToken&Version=2023-08-01

请求参数 #

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

Query #

返回参数 #

请求示例 #

GET https://livesaas.volcengineapi.com/?Action=GetInviterToken&Version=2023-08-01&ActivityId=177985****487296&UserId=181876****470490&ExternalId=14039

返回示例 #

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetInviterToken",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "InviterToken": "p8g****aES"
    }
}

错误码 #

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。