API中心/查询任务列表
 
 

查询任务列表

POST
https://api.itniotech.com/aivoice/taskList
查询任务列表。
 
请求参数
参数 说明 是否必填 类型
current 当前页码，1-N 是 Int
size 每页显示数，1-100 是 Int
params 查询参数 是 Object
appId 应用id 是 String
name 任务名称 否 String
 
请求示例
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"
    }
}
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见响应状态码说明 String
reason 失败原因说明 String
data 返回数据 Object
total 总条数 Long
size 每页显示条数 Int
current 当前页 Int
pages 总页数 Int
records 记录 Array
jobId 任务id Long
name 任务名称 String
dialogFlowName 话术名称 String
jobPhoneNumberName 线路名称 String
robotCount 任务使用的AI并发数 Int
mode 任务启动方式(MANUAL 手动，AUTO 自动) String
hangupSms 是否开启挂机短信 Boolean
taskTotal 总呼叫总数 Int
taskCompleted 呼叫成功数量 Int
status 任务状态 String
isDialogFlowUnbind 话术是否解绑 String
createTime 创建时间 String
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-4 时间戳过期
-6 ip限制
-37 应用不存在
-49 账号未认证
-50 应用未报价
-57 签名不能为空
-58 时间戳不能为空
-59 apikey不能为空
删除任务
查询未完成任务电话号码

意见反馈

文档内容是否对您有帮助?

 

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
    }
}