请求结构

发起 API 请求的 URL 由不同参数拼凑而成，有固定的请求结构。本文介绍云 PBX的 API 请求结构，包括通信协议、请求方式和请求地址说明。

结构示例

下面为签入队列的请求示例。

POST /api/v2.0.0/queue/add_dynamicagent?token=1e3b3ebb6a974cb42ed31de5413df52d 
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
	"queuenumber": "6700",
	"extnumber": "1000",
	"password": "6700123"
}

POST 表示请求方式。
/api/v2.0.0 即 API 路径，表示 API 版本号。
queue/add_dynamicagent 表示要调用的 API 接口签入队列。
token=1e3b3ebb6a974cb42ed31de5413df52d 表示用于验证请求合法性的 token。
Content-Type:application/json; charset=utf-8 表示请求内容格式。
Host 表示云 PBX 的域名。
queuenumber、extnumber、password 表示具体请求参数。

通信协议

云 PBX API 使用 HTTPS 通信协议，所有 API 请求均使用 HTTPS POST 方式调用。

请求地址格式

API URL 由 Base URL、Endpoint 和 API token 组成，统一格式如下。

注：获取 API token 和刷新 API token 请求地址无需带 token。

{base_url}/{api_path}/{endpoint}?token={token}

{base_url}

本手册中，所有 API 请求示例，都使用下面的的Base URL：

https://{pbx_domain}

{api_path}: API 的路径格式为 api/{version}，其中，{version} 为 API 版本号。; 本文档中，使用的 API 版本为 v2.0.0，所有的 API 接口的 api_path 都是 api/v2.0.0

{endpoint}

Endpoint （终点），也称作 “路径”，表示 API 请求地址的具体地址。

关于云 PBX 支持的所有 Endponit，请参见 API 接口&事件概览。

{token}

Token 为 API 接口的调用凭证。应用服务器请求调用 PBX 的 API 接口之前，必须先获取 API token。之后的所有 API 请求都必须在 API URL 带上 token，否则 API 接口调用将会失败。

详细的 API 认证说明，请参见API 认证机制。