售前電話(huà)
135-3656-7657
售前電話(huà) : 135-3656-7657
我公司的提供豐富API接口,為各行業(yè)通信整合集成提供方便!下面,小編一一為大家列出:
登錄和系統(tǒng)基礎(chǔ)信息獲?。?/p>
## 登錄和獲取系統(tǒng)基礎(chǔ)信息絕大多數(shù)接口都需要登錄后使用
### 登錄
地址:/login
方法:POST
參數(shù):
```json
{
"username": "string",--------------------用戶(hù)名
"password": "string"---------------------密碼
}
```
響應(yīng):
```json
{
"result": "api"--------------------------結(jié)果
}
```
會(huì)給出用戶(hù)身份以及cookie,如果返回的結(jié)果是“login”則代表登錄失敗
返回結(jié)果的可能值:
- admin---------------------管理員
- operator------------------接線(xiàn)員
- api-----------------------api接口
- login---------------------需要登錄,登錄失敗
返回的cookie的名稱(chēng)是`JSESSIONID`,值類(lèi)似于`FC16EC02923FD2BAE77B1673613BFBF6`
兩次數(shù)據(jù)訪(fǎng)問(wèn)之間的最長(zhǎng)有效期為半小時(shí),否則需要重新登錄,訪(fǎng)問(wèn)需要登錄的接口(地址以`/api/`開(kāi)頭)會(huì)出現(xiàn)403錯(cuò)誤
### 維持會(huì)話(huà)有效性
可以使用ping請(qǐng)求維持有效性
地址:/api/ping
方法:GET
響應(yīng):
```json
{
"result": "pong"
}
```
響應(yīng)不具有意義,該請(qǐng)求用于維持會(huì)話(huà)有效和檢查權(quán)限
### 系統(tǒng)型號(hào)信息
地址:/system-info/model-info
方法:GET
響應(yīng):
```json
{
"model": "080",-----------------------------型號(hào)識(shí)別碼
"showModel": "CooVox-U80",------------------型號(hào)顯示名稱(chēng)
"extenLimit": 200---------------------------最大分機(jī)數(shù)限制
}
```
這個(gè)取決于具體的設(shè)備
數(shù)字分機(jī)管理接口:
## 數(shù)字分機(jī)管理
數(shù)字分機(jī)包括SIP和iax,iax作為可選項(xiàng)進(jìn)行開(kāi)通,默認(rèn)均為sip
### 查詢(xún)
地址:/api/extension-digital/list-extension-page
方法:POST
參數(shù)
```json
{
"keyword": "",--------------------------查詢(xún)關(guān)鍵字,對(duì)分機(jī)號(hào)、用戶(hù)名、部門(mén)名進(jìn)行模糊匹配,空字符串會(huì)得到所有記錄
"page": {
"pageNumber": 0,----------------------分頁(yè)的當(dāng)前頁(yè)碼,從0開(kāi)始
"size": 1,----------------------------每一頁(yè)的允許的最大記錄數(shù),最小1
"sort": {-----------------------------對(duì)結(jié)果排序
"direction": "ASC",-----------------排序的方式,ASC:升序,DESC:降序
"order": "exten"--------------------排序的屬性,支持后面返回中分機(jī)屬性的任意屬性
}
}
}
```
響應(yīng):
```json
{
"content": [----------------------------結(jié)果的主體部分,以數(shù)組形式給出,沒(méi)有符合條件結(jié)果會(huì)是空數(shù)組
{
"exten": "100",---------------------分機(jī)號(hào)
"username": "測(cè)試1",-----------------來(lái)電顯示名稱(chēng),最長(zhǎng)不超過(guò)32個(gè)字符
"password": "123456",---------------注冊(cè)密碼
"pinCode": "516",-------------------快速注冊(cè)碼
"email": "",------------------------郵箱地址
"outboundCid": "18583230080",-------外呼顯示號(hào)碼
"mobileNumber": "",-----------------移動(dòng)號(hào)碼(暫時(shí)沒(méi)有使用)
"language": "en",-------------------提示音語(yǔ)言,語(yǔ)言代碼
"voicemail": true,------------------是否開(kāi)啟語(yǔ)音信箱,true/false
"voicemailPassword": "1234",--------語(yǔ)音信箱密碼
"remoteExten": false,---------------是否開(kāi)啟遠(yuǎn)程分機(jī),true/false,開(kāi)啟建議密碼強(qiáng)度比較高
"registCount": 3,-------------------允許同時(shí)注冊(cè)終端數(shù)目
"videoCall": true,------------------是否開(kāi)啟視頻通話(huà),true/false
"videoCallCodec": "h264",-----------視頻通話(huà)的編碼,vp8、h264、h263、h261、h263p,單一編碼
"webRtc": true,---------------------是否允許web登錄,true/false
"recording": "none",----------------錄音,none:不開(kāi)錄音,in:呼入錄音,out:呼出錄音,both:呼入呼出都錄音
"callSpy": false,-------------------是否允許監(jiān)聽(tīng),true/false
"transport": "UDP",-----------------注冊(cè)協(xié)議,UDP/TCP/TLS,單一編碼
"dtmf": "rfc4733",------------------dtmf模式,auto/rfc4733/inband/info,單一
"srtp": false,----------------------是否開(kāi)啟加密,true/false
"qualify": 60,----------------------在線(xiàn)檢測(cè)間隔時(shí)間,0表示關(guān)閉,單位秒