请求结构

本文介绍S系列IPPBX 的 API 请求结构,包括通信协议、请求方式和请求地址说明。

所有的 API 请求方式都是 POST。

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

POST /api/v1.1.0/queue/add_dynamicagent?token={token} HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "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 表示S系列IPPBX的 IP 地址。
  • queueidextidpassword 表示具体请求参数。

请求地址

API 请求地址格式:

{base_url}{endpoint}
  • Base URL

    根据 PBX 的网页访问设置,填写 API 请求的 Base URL。

    如果你使用 HTTPS 协议进行通信,Base URL 的格式如下:

    https://{pbx_ip}:{https_port}

    如果你使用 HTTP 协议进行通信,Base URL 的格式如下:

    http://{pbx_ip}:{http_port}
  • Endpoint

    Endpoint (终点),也称作 “路径”,表示 API 请求的具体地址。

    点击API 接口概览,查看S系列IPPBX 支持的所有 API endpoint。