获取 Token GetAppToken--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取 Token GetAppToken

最近更新时间：2024.01.24 14:42:44首次发布时间：2024.01.24 14:42:44

你可以指定你所属的 AppId，UserId 和 Token 过期时间来生成 Token进行鉴权，以进行通讯。

使用说明

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 50。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=GetAppToken&Version=2020-12-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
UserId	Long	是	`10001`	用户 UserId
ExpireTime	Long	是	`1704880332100`	Token 过期时间，unix 时间戳，单位为毫秒

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
AppId	Integer	`000000`	应用的唯一标志
UserId	Long	`10001`	用户UserId
Token	String	`Your_Token`	生成的 Token

请求示例

POST https://rtc.volcengineapi.com?Action=GetAppToken&Version=2020-12-01
{
    "AppId": 000000,
    "UserId": 10001,
    "ExpireTime": 1704880332100
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetAppToken",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "AppId": 000000,
        "UserId": 10001,
        "Token": "Your_Token"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。