GetSDKTokenAPI - 获取观众进入直播间的授权 Token--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetSDKTokenAPI - 获取观众进入直播间的授权 Token

最近更新时间：2025.03.24 16:50:54首次发布时间：2022.03.29 22:10:12

获取观众通过观播 SDK 进入直播间所需的授权 Token。

注意

调用接口前，请确保请求参数的有效及安全性，以防被恶意攻击。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetSDKTokenAPI`	接口名称。当前 API 的名称为 `GetSDKTokenAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`17725678580`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Mode	Integer	是	`1`	直播间 Token 的类型。 `1`：公开直播间类型，观众可以直接进入直播间 `2`：自定义直播间类型，需要同时传入观众昵称和观众 ID
Nickname	String	否	`张三`	观众昵称。说明当 `Mode` 取值为 `2` 时，该参数必选。为避免个人信息泄露，请勿使用手机号、身份证号等信息作为观众昵称。
UserIdStr	String	否	`57584`	观众 ID。说明当 `Mode` 取值为 `2` 时，该参数必选。为避免个人信息泄露，请勿使用手机号、身份证号等信息作为观众 ID。
InviteToken	String	否	`abcd`	WebSDK 使用直播分享功能时，传入 path（直播分享地址）上 `inviter_token` 对应的数据。仅当 `Mode` 取值为 `2` 时该参数会生效。例如：path 为 `https://test.live.com/123/456?inviter_token=abcd`，则传入的 `InviteToken` 为 `abcd`。
AvatarUrl	String	否	`http://xxx.example`	观众头像图片，仅集成了 iOS/Android 观播 SDK 的观看页支持展示观众头像。
CustomComment	String	否	`北京`	中奖名单中观众昵称右侧的自定义信息，例如中奖者所在的地区。最多支持 50 个字符。仅当 `Mode` 为 `2` 时该参数会生效。

返回参数

参数	类型	示例值	描述
Token	String	`hdshdfdi`	观众通过观播 SDK 进入直播间所需的授权 Token。注意当 `Mode` 取值为 `2` 时，会返回经过编码（urlEncode）的 `Token`。在将 `Token` 传递给观播 SDK 时，您必须自行对 `Token` 进行解码（urlDecode），否则会导致观播 SDK Token 鉴权失败。

请求示例

POST https://livesaas.volcengineapi.com/?Action=GetSDKTokenAPI&Version=2020-06-01
{
    "ActivityId": 17725678580,
    "Mode": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetSDKTokenAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    },
    "Result": {
        "Token": "hdshdfdi"
    }
}

错误码

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