获取 API token

注：

如果密码连续错误五次，则应用服务器的 IP将会被锁 10 分钟。登录 PBX 网页，可以马上删除被拉黑 IP 地址。

请求地址

{base_url}/{api_path}/login

请求参数


参数	是否必选	类型	描述
username	是	String	在 PBX API 网页设置的用户名。
password	是	String	将PBX API 网页设置的密码经过 MD5 加密，填写加密后的32位小写字符串。
version	否	String	发送事件报告格式的版本。注：本文档使用事件报告版本为 2.0.0。如果不带此参数，默认发送的事件报告版本为 1.0.0，建议设置此参数，获取正确格式的事件报告。
port	否	String	应用服务器要监听此端口，接收 PBX 发送的事件报告。注：如果你选择报告发送方式为 HTTP，此参数必填。默认值：8260。
url	否	String	应用服务器获取事件报告的 URL。注：此参数仅适用于报告发送方式为 HTTP 的情况。如果不带此参数，则 PBX 默认向应用服务器的 IP 地址发送事件报告。
urltag	否	String	指定 URL 的类型。注：此参数仅适用于报告发送方式为 HTTP 的情况。取值范围： 0：定义`url`的值为相对路径。PBX 会将相对路径的`url`与应用服务器的 IP 地址结合起来，发送事件报告到具体的路径。例如：应用服务器 IP 地址为110.22.2.3；监听端口为8260；`url`设置为report；则 PBX 发送事件报告到110.22.2.3:8260/report 。 1：定义`url`的值为绝对路径。例如：应用服务器 IP 地址为110.22.2.3；`url`设置为110.22.2.3:8260/report；则 PBX 发送事件报告到110.22.2.3:8260/report 。注：使用绝对路径，可以避免复杂网络环境下，事件报告无法发送成功的问题。默认值：0。

响应参数


参数	类型	描述
status	String	请求结果。 Success：请求成功。 Failed：请求失败。
token	String	调用接口凭证，所有的 API 接口调用都需要带 token。
transport	String	PBX 向应用服务器推送报告的协议。 HTTP：PBX 采用 TCP 短连接的方式发送 HTTP 事件报告。 TCP：PBX 采用 TCP 长连接的方式发送 TCP 事件报告。关于事件报告发送形式的说明，请参见API 事件推送。

示例

请求示例

POST /api/v2.0.0/login HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
    "username": "api",
    "password": "2d7257a528679d01a19c70e3fa773870",
    "port": "8260",
    "version": "2.0.0"
}

响应示例

第三方应用服务器登录成功。

HTTP/1.1 200 OK
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success",
    "token": "48a7d7481a5355aa4fb5dc285edeb40e",
    "transport": "TCP"
}

第三方应用服务器登录失败。

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
      "status": "Failed", 
      "errno": "30003"
}