请求结构
本文介绍云 PBX 的 API 请求结构,包括通信协议、请求方式和请求地址说明。
Yeastar云PBX API 使用 HTTPS 通信协议。所有的 API 请求方式都是 POST。
下面为 签入队列的请求示例。
POST /api/v1.1.0/queue/add_dynamicagent?token={token} HTTP/1.1 Content-Type:application/json; charset=utf-8 Host: api.yeastarcloud.com { "queueid": "6700", "extid": "1000", "password": "6700123" }
POST
表示请求方式。/api/v1.1.0/queue/add_dynamicagent?token={token}
表示 签入队列的请求终端路径(Endpoint)。Content-Type:application/json; charset=utf-8
表示请求内容格式。Host
表示云 PBX 的域名。queueid
、extid
、password
表示具体请求参数。
请求地址
API 请求地址格式:
{base_url}{endpoint}
- Base URL
本指南中,所有 API 请求示例,都使用下面的 Base URL:
https://{pbx_domain}
- Endpoint
Endpoint (终点),也称作 “路径”,表示 API 请求的具体地址。
点击API 接口概览,查看云 PBX 支持的所有 API endpoint。