文档中心
云端录制旧版文档
API 文档
获取 AccessToken

获取 AccessToken

更新时间：2023-09-18 15:52

1 描述

access_token 是接口的全局唯一凭证，接入方调用各接口时都需使用。access_token 的有效期为 2 个小时，需定时刷新并妥善保存。

2 接口原型

请求方式：POST/JSON

请求地址：

服务环境	调用频率限制	请求地址
国内正式环境	10 次/秒	https://cloudrecord-sh.zego.im/access_token
国内测试环境	10 次/秒	https://cloudrecord-test.zego.im/access_token
海外正式环境	10 次/秒	https://cloudrecord-hk.zegocloud.com/access_token
海外测试环境	10 次/秒	https://cloudrecord-test.zegocloud.com/access_token

传输协议：HTTPS

3 请求参数

参数	类型	是否必选	描述
app_id	Int64	是	ZEGO 给开发者分配的 AppID，唯一标识一个应用。
seq	Int64	是	协议序列号，可以填任意值。建议每次请求的该值唯一，可使用时间戳。
token	String	是	ZEGO 后台服务认证凭证。
version	Int	是	协议版本号，默认填为 1。

token 生成规则说明：

tokenInfo = '{
    "ver": 1,
    "hash": "0800fc577294c34e0b28ad2839435945",
    "nonce": "0123456789ABCDEF",
    "expired": 1592028898 // 单位：秒
}'
 
// 注意这里要先构造 JSON，再转成字符串
token = base64(tokenInfo)

其中，tokenInfo 为 JSON 格式的字符串，tokenInfo 中各字段说明如下：

参数	类型	描述
ver	Int	版本号，默认填写 1。
hash	String	hash = md5sum(sprintf("%u%s%s%u",app_id,server_app_secret,nonce,expired)); md5sum 最终结果为 32 个字节的小写 hex 编码字符串。
nonce	String	随机字符串，长度为 16 字节。
expired	Int64	token 失效时间，为 Unix 时间戳，单位：秒。

tokenInfo 中的 hash 字段生成规则说明：

参数	类型	描述
app_id	Int64	App 唯一标识。
server_app_secret	String	ServerSecret App 唯一凭证密钥，长度为 16 个字节，请从 ZEGO 控制台获取。

4 请求示例

以下是 access_token 接口的请求示例。

{
    "version": 1,
    "seq": 1,
    "app_id": 0000,
    "token": "TOKEN"
}

5 响应参数

参数	类型	描述
code	Int	错误码。
message	String	错误描述。
data	Object	token 信息。

data成员如下：

参数	类型	描述
access_token	String	获取到的凭证。
expires_in	Int64	凭证有效时间，单位：秒。

6 响应示例

以下是 access_token 接口的响应示例。

{
    "code": 0,
    "data": {
        "access_token": "c205dytwQTd4ZlZjSjBLTXY0V3FzYUtBY1Q9ZEo0eGFJcEt3WVBKSlFGeXh5aGZITjJWYnlBcT0",
        "expires_in": 7200
    },
    "message": "success"
}