Inquire Phone
https://api.itniotech.com/voice/sipQuery
Parameters | Description | Required | Type |
---|---|---|---|
current | Current page number: 1-N, default 1, cannot be passed empty | Yes | Int |
size | Number displayed on each page: 1-100, default 25, cannot be passed empty | Yes | Int |
params | Parameters on each page | Yes | JSONObject | -
appId | Audio application ID | Yes | String |
Request URL: https://api.itniotech.com/voice/sipQuery Request Method: POST Request Headers: Content-Type: application/json;charset=UTF-8 Sign: 05d7a50893e22a5c4bb3216ae3396c7c Timestamp: 1630468800 Api-Key: bDqJFiq9 Request Body: { "current":1, "size":20, "params":{ "appId":"4luaKsL2" } }
Parameters | Description | Type |
---|---|---|
status | "0"means successful, others than 0 means failure, seeing Status Code description. | String |
reason | Failure reason description | String |
data | Data on each page | JSONObject | -
total | Total record number | Int |
size | Number displayed on each page | Int |
current | Current page number | Int |
pages | Total pages | Int |
records | Data set | JSONArray | -
groupName | Name of phone group | String |
phoneName | Phone name | String |
account | Phone account | String |
password | Phone password | String |
displayNum | Phone display number | String |
status | Description |
---|---|
0 | success |
-1 | Authentication error |
-2 | Restricted IP access |
-16 | Timestamp expires |
-18 | Port program unusual |
-22 | Parameter exception |
Java
PHP
REQUEST
import cn.hutool.core.codec.Base64; import cn.hutool.crypto.SecureUtil; import cn.hutool.http.Header; import cn.hutool.http.HttpRequest; import cn.hutool.http.HttpResponse; import cn.hutool.json.JSONObject; import cn.hutool.json.JSONUtil; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.time.LocalDateTime; import java.time.ZoneId; public void sipQuery() { final String baseUrl = "https://api.itniotech.com/voice"; final String apiKey = "your api key"; final String apiPwd = "your api secret"; final String appId = "{{appId}}"; final Integer current = "{{current}}"; final Integer size = "{{size}}"; final JSONObject params = JSONUtil.createObj() .set("appId", appId); final String url = baseUrl.concat("/sipQuery"); HttpRequest request = HttpRequest.post(url); // generate md5 key final String datetime = String.valueOf(LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().getEpochSecond()); final String sign = SecureUtil.md5(apiKey.concat(apiPwd).concat(datetime)); request.header(Header.CONTENT_TYPE, "application/json;charset=UTF-8") .header("Sign", sign) .header("Timestamp", datetime) .header("Api-Key", apiKey); final String body = JSONUtil.createObj() .set("current", current) .set("size", size) .set("params", params) .toString(); HttpResponse response = request.body(body).execute(); if (response.isOk()) { String result = response.body(); System.out.println(result); } }
REQUEST
header('content-type:text/html;charset=utf8'); $apiKey = "your api key"; $apiSecret = "your api secret"; $appId = "{{appId}}"; $url = "https://api.itniotech.com/voice/sipQuery"; $timeStamp = time(); $sign = md5($apiKey.$apiSecret.$timeStamp); $dataArr['current'] = "{{current}}"; $dataArr['size'] = "{{size}}"; $dataArr['params'] = array("appId"=>"$appId"); $data = json_encode($dataArr); $headers = array('Content-Type:application/json;charset=UTF-8',"Sign:$sign","Timestamp:$timeStamp","Api-Key:$apiKey"); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL,$url); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 600); curl_setopt($ch, CURLOPT_HTTPHEADER,$headers); curl_setopt($ch, CURLOPT_POSTFIELDS , $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); $output = curl_exec($ch); $error = curl_error($ch); curl_close($ch); var_dump($output);
RESPONSEEXAMPLE
{ "status": "0", "reason":" success", "data": { "total": 5, "size": 20, "current": 1, "pages": 1, "records":[ { "groupName":"sipGroup", "phoneName":"sip-1", "account":"test_001", "password":"LX9FZdF2", "displayNum":"861000000" } ] } }