获取访问 Token

Access token，即访问令牌或访问 token，是 API 接口调用的凭证，用于校验 API 接口调用是否有权限。第三方应用程序需要申请一个访问 token，并在每个请求中携带访问令牌来访问API。

前提条件

你已在 Yeastar P 系列云 PBX 启用 API 功能。更多信息，请参见启用 Yeastar P 系列云 PBX API。

请求 URL

POST {base_url}/{api_path}/get_token

请求参数

重要：需注意，每个发送到 Yeastar P 系列云 PBX API 的请求，其头域 (Headers) 中都需要携带 User Agent (UA) 信息，以便 PBX 能够识别你的应用并响应请求。例如：

User-Agent:
                OpenAPI

。


参数	是否必填	类型	说明
username	是	String	用户名。在 PBX 网页端口上获取客户端 ID 作为用户名。
password	是	String	密码。在 PBX 网页端口上获取客户端密钥作为密码。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
access_token_expire_time	Integer	访问 token 有效时长。单位：秒(s)
access_token	String	API 接口调用凭证。所有的请求都需要带一个访问 token。
refresh_token_expire_time	Integer	刷新 token 有效时长。单位：秒(s)
refresh_token	String	刷新 token。此刷新 token 可用于获取新的访问 token 和刷新 token。

示例

请求示例

POST /openapi/v1.0/get_token

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
User-Agent: OpenAPI
{
	"username": "UEnH9Dmv6uBJEXsYcag1trNfQThYXXXX",
	"password": "ZLcXl63S9EtMnYoHUnjbVo6sA8CbXXXX"
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "access_token_expire_time": 1800,
    "access_token": "EXZMpZAO86mbrKm6rFtgeb3rfcpC9uqS",
    "refresh_token_expire_time": 86400,
    "refresh_token": "SCduGecwbG9jIusiS8FxFUVn3kf0Q9R8"
}