API Center/Query the List of Available Outbound Lines

Query the List of Available Outbound Lines

POST

https://api.itniotech.com/aivoice/channelList

Query the list of available outbound lines.
Request Parameters
appId
String
Required
Application id
Request Sample
Request URL:
    https://api.itniotech.com/aivoice/channelList
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "appId":"LILIN888"
}
Response Parameters
Parameters Description Type
status "0"means successful, others than 0 means failure, seeing Status code description String
reason Failure Reason Description String
data Return Data Array
 tenantPhoneNumberId line id String
 phoneNumber Line name String
Response Status Code
status Description
0 Success
-1 Authentication error
-4 Timestamp expires
-5 Port program unusual
-6 Restricted IP access
-27 Abnormal parameter verification
-37 Application does not exist
-49 Account not authenticated
-57 The Sign cannot be empty
-58 The Timestamp cannot be empty
-59 The Api-Key cannot be empty
Query Script List
Create AI Outbound Task

Feedback

Was this page helpful?

language

Java

PHP

REQUEST

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.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

public void channelList() {
    final String baseUrl = "https://api.itniotech.com/aivoice";
    final String apiKey = "your api key";
    final String apiPwd = "your api secret";
    final String appId = "{{appId}}";

    final String url = baseUrl.concat("/channelList");
    HttpRequest request = HttpRequest.post(url);

    // currentTime
    final String datetime = String.valueOf(LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().getEpochSecond());
    // generate md5 key
    final String sign = SecureUtil.md5(apiKey.concat(apiPwd).concat(datetime));
    request.header(Header.CONNECTION, "Keep-Alive")
            .header(Header.CONTENT_TYPE, "application/json;charset=UTF-8")
            .header("Sign", sign)  //Signature with encryption
            .header("Timestamp", datetime) //Current system time stamp (second)
            .header("Api-Key", apiKey); //API KEY（Home-Developer options）

    final String params = JSONUtil.createObj()
            .set("appId", appId)
            .toString();

    HttpResponse response = request.body(params).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/aivoice/channelList";
$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);

$dataArr['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);
curl_close($ch);
var_dump($output);

RESPONSEEXAMPLE

{
    "status": 0,
    "reason": "success",
    "data": [
        {
            "tenantPhoneNumberId": "2959",
            "phoneNumber": "line-63"
        },
        {
            "tenantPhoneNumberId": "2958",
            "phoneNumber": "testRealLine"
        }
    ]
}