API Center/Query Task List

Query Task List

POST

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

Query task list.
Request Parameters
Parameters Description Required Type
current Current page, 1-N Yes Int
size Number of displays per page, 1-100 Yes Int
params Query parameters Yes Object
 appId Application id Yes String
 name Task name No String
Request Sample
Request URL:
    https://api.itniotech.com/aivoice/taskList
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "current":1,
    "size":1,
    "params":{
        "appId":"LILIN888",
        "name":"name8"
    }
}
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 Object
 total Total number Long
 size Number of items displayed per page Int
 current Current Page Int
 pages Total Pages Int
 records Record Array
jobId Task id Long
name Task name String
dialogFlowName Script name String
jobPhoneNumberName Line name String
robotCount AI concurrency used by tasks Int
mode Task startup mode (MANUAL, AUTO) String
hangupSms Whether to enable SMS on hook Boolean
taskTotal Total number of calls Int
taskCompleted Number of successful calls Int
status Task status String
isDialogFlowUnbind Whether the script is untied String
createTime Create time String
Response Status Code
status Description
0 Success
-1 Authentication error
-4 Timestamp expires
-6 Restricted IP access
-37 Application does not exist
-49 Account not authenticated
-50 Application not quoted
-57 The Sign cannot be empty
-58 The Timestamp cannot be empty
-59 The Api-Key cannot be empty
Delete Task
Get the Unfinished Task Phone Number

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 taskList() {
    final String baseUrl = "https://api.itniotech.com/aivoice";
    final String apiKey = "your api key";
    final String apiPwd = "your api secret";
    final String appId = "your appid";

    final String url = baseUrl.concat("/taskList");
    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）

    JSONObject params = JSONUtil.createObj()
            .set("appId", appId)
            .set("name", "Your task name"); //Task name
    String page = JSONUtil.createObj()
            .set("current", 1)  //Current page, 1-N
            .set("size", 10)  //Number of displays per page, 1-100
            .set("params", params)
            .toString();

    HttpResponse response = request.body(page).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 = "your appid";
$url = "https://api.itniotech.com/aivoice/taskList";
$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);

$dataArr['current'] = 1;
$dataArr['size'] = 10;
$dataArr['params'] = array(
    'appId' => $appId,
    'name' => "Your task name"
);

$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": {
    "records": [
            {
                "jobId": 20,
                "name": "name8",
                "dialogFlowName": "name8.12",
                "jobPhoneNumberName": "line63",
                "robotCount": 1,
                "mode": "AUTO",
                "hangupSms": false,
                "taskTotal": 0,
                "taskCompleted": 0,
                "status": "NOT_STARTED",
                "isDialogFlowUnbind": false,
                "createTime": "2022-09-20 16:57:04"
            }
        ],
        "total": 1,
        "size": 25,
        "current": 1,
        "searchCount": true,
        "pages": 1
    }
}