我公司的提供丰富API接口，为各行业通信整合集成提供方便！下面，小编一一为大家列出：

登录和系统基础信息获取：

## 登录和获取系统基础信息绝大多数接口都需要登录后使用

### 登录

地址:/login

方法：POST

参数：

```json

{

  "username": "string",--------------------用户名

  "password": "string"---------------------密码

}

```

响应：

```json

{

  "result": "api"--------------------------结果

}

```

会给出用户身份以及cookie，如果返回的结果是“login”则代表登录失败

返回结果的可能值：

- admin---------------------管理员  

- operator------------------接线员

- api-----------------------api接口

- login---------------------需要登录，登录失败

返回的cookie的名称是`JSESSIONID`，值类似于`FC16EC02923FD2BAE77B1673613BFBF6`

两次数据访问之间的最长有效期为半小时，否则需要重新登录，访问需要登录的接口(地址以`/api/`开头)会出现403错误

### 维持会话有效性

可以使用ping请求维持有效性

地址：/api/ping

方法：GET

响应：

```json

{

  "result": "pong"

}

```

响应不具有意义，该请求用于维持会话有效和检查权限

### 系统型号信息

地址：/system-info/model-info

方法:GET

响应：

```json

{

  "model": "080",-----------------------------型号识别码

  "showModel": "CooVox-U80",------------------型号显示名称

  "extenLimit": 200---------------------------最大分机数限制

}

```

这个取决于具体的设备

数字分机管理接口：

## 数字分机管理

数字分机包括SIP和iax，iax作为可选项进行开通，默认均为sip

### 查询

地址：/api/extension-digital/list-extension-page

方法：POST

参数

```json

{

  "keyword": "",--------------------------查询关键字，对分机号、用户名、部门名进行模糊匹配，空字符串会得到所有记录

  "page": {

    "pageNumber": 0,----------------------分页的当前页码，从0开始

    "size": 1,----------------------------每一页的允许的最大记录数，最小1

    "sort": {-----------------------------对结果排序

      "direction": "ASC",-----------------排序的方式，ASC:升序,DESC：降序

      "order": "exten"--------------------排序的属性，支持后面返回中分机属性的任意属性

    }

  }

}

```

 

响应：

 

```json

{

  "content": [----------------------------结果的主体部分，以数组形式给出，没有符合条件结果会是空数组

    {

      "exten": "100",---------------------分机号

      "username": "测试1",-----------------来电显示名称，最长不超过32个字符

      "password": "123456",---------------注册密码

      "pinCode": "516",-------------------快速注册码

      "email": "",------------------------邮箱地址

      "outboundCid": "18583230080",-------外呼显示号码

      "mobileNumber": "",-----------------移动号码（暂时没有使用）

      "language": "en",-------------------提示音语言,语言代码

      "voicemail": true,------------------是否开启语音信箱，true/false

      "voicemailPassword": "1234",--------语音信箱密码

      "remoteExten": false,---------------是否开启远程分机，true/false,开启建议密码强度比较高

      "registCount": 3,-------------------允许同时注册终端数目

      "videoCall": true,------------------是否开启视频通话，true/false

      "videoCallCodec": "h264",-----------视频通话的编码，vp8、h264、h263、h261、h263p，单一编码

      "webRtc": true,---------------------是否允许web登录，true/false

      "recording": "none",----------------录音，none：不开录音,in：呼入录音,out：呼出录音,both：呼入呼出都录音

      "callSpy": false,-------------------是否允许监听，true/false

      "transport": "UDP",-----------------注册协议，UDP/TCP/TLS，单一编码

      "dtmf": "rfc4733",------------------dtmf模式，auto/rfc4733/inband/info，单一

      "srtp": false,----------------------是否开启加密，true/false

      "qualify": 60,----------------------在线检测间隔时间，0表示关闭，单位秒