査詢話機 - API Center

査詢話機

POST

https://api.laaffic.com/v3/voice/sipQuery

查詢指定語音應用下已創建的話機。

請求參數

參數	説明	是否必填	類型
current	當前頁碼，1-N	是	Int
size	每頁顯示數，1-100	是	Int
params	分頁參數	是	JSONObject
appId	語音應用id	是	String

請求示例

Request URL:
    https://api.laaffic.com/v3/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"
    }
}

響應參數

參數	説明	類型
status	狀態碼，0表示成功，其他均爲失敗，詳見響應狀態碼	String
reason	失敗原因説明	String
data	分頁數據	JSONObject
total	總記錄條數	Int
size	每頁顯示數	Int
current	當前頁碼	Int
pages	總頁碼	Int
records	數據集合	JSONArray
groupName	話機組名稱	String
phoneName	話機名稱	String
account	話機帳號	String
password	話機密碼	String
displayNum	話機顯示號碼	String

響應狀態碼

狀態碼	説明
0	成功
-1	帳號認證異常
-2	IP訪問受限
-16	超出時間限制
-18	系統異常
-22	參數異常

語言

Java

PHP

請求

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.laaffic.com/v3/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);
    }
}

請求

header('content-type:text/html;charset=utf8');

$apiKey = "your api key";
$apiSecret = "your api secret";
$appId = "{{appId}}";
$url = "https://api.laaffic.com/v3/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);

響應示例

{
    "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"
            }
        ]
    }
}