You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

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

最近更新时间：2023.11.08 09:30:19

首次发布时间：2022.03.29 22:10:12

我的收藏

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

注意

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

注意事项

请求频率：单用户请求频率限制为 5000 次/分钟。

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

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

Body

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

AvatarUrlString否http://xxx.example观众头像图片，仅集成了 iOS/Android 观播 SDK 的观看页支持展示观众头像。
CustomCommentString否北京中奖名单中观众昵称右侧的自定义信息，例如中奖者所在的地区。最多支持 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"
  }
}

错误码

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