PBX REST API 开发者手册介绍
一、简介
Ubiix PBX API是基于HTTP的RESTful API。 API请求和响应主体采用JSON格式。
重要提示：您无法按原样运行本指南中的示例请求。用您自己的值替换特定于呼叫的参数（如令牌和ID）。
认证和授权
Ubiix REST API请求端口如下所示：
HTTP：8899
HTTPS：8900
举例：
· 假设您已将您的PBX安装在IP为216.58.123.206的服务器上。在调用REST API时，API基本URL应为：http：//216.58.123.206：8899 / api /或https：// 216.58.123.206:8900/api/。您可以将API资源路径加载到基本网址。
· 假设您已将域www.bestpbx.com解析为IP 216.58.123.206，那么API基本URL应为：http://www.bestpbx.com:8899/api/或https://www.bestpbx.com： 8900 / API /。您可以将API资源路径追加到基本网址。
在调用任何Ubiix PBX REST API之前，您必须先获取访问令牌。您应该使用帐户登录API来获得授权，并且Ubiix PBX将在更改凭证后颁发访问令牌。
get访问令牌响应中的access_token字段包含一个不记名令牌：
{
“access_token”：“3BCC13E6F5D34A09B75EC753B433D778”，
“过期”：“600”，
“角色”：“管理员”，
“api_version”：“9.0.0”，
}
您必须在每个后续请求中使用此访问令牌。当REST API成功调用时，访问令牌将自动刷新。
注意：您必须使用刷新令牌API在访问令牌到期之前刷新该令牌。
访问令牌具有有限的生命周期。帐户登录API响应中的expires字段指示访问令牌的生存期（以秒为单位）。例如，到期值3600表示访问令牌从响应生成的一小时内过期。
在创建另一个令牌之前，请重新使用访问令牌直至过期。
HTTP方法是：
方法
|
描述
|
GET
|
显示资源或列表资源的详细信息。
|
POST
|
创建或管理资源。
|
API响应
Ubiix PBX API调用返回HTTP状态代码。一些API调用还会返回包含有关资源信息的JSON响应bodyAPI响应。
HTTP状态码
每个REST API请求都会返回成功或错误的HTTP状态码。
成功
在响应中，Ubiix PBX为成功的请求返回这些HTTP状态码：
错误
在对失败请求的响应中，Ubiix PBX返回HTTP 4XX或5XX状态码。错误
更新资源
当您调用Ubiix PBX REST API更新资源时，除必需的参数外，其他参数都是可选的。
如果不想更新参数，则不应将参数作为key放入JSON体中。
