API中心/暂停任务
 
 

暂停任务

POST
https://api.itniotech.com/aivoice/taskStop
暂停任务。
 
请求参数
appId
String
必填
应用id
jobId
Long
必填
任务id
 
请求示例
Request URL: 
    https://api.itniotech.com/aivoice/taskStop
Request Method: 
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: b8qJFiq9
Request Body:
{
    "appId":"LILIN888",
    "jobId":10886
}
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见响应状态码说明 String
reason 失败原因说明 String
data null null
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-3 余额不足
-4 时间戳过期
-6 ip限制
-27 参数校验异常
-32 外呼任务不存在
-33 外呼任务名称已存在
-37 应用不存在
-38 当前任务状态不可暂停
-39 当前任务状态不可启动
-45 未导入客户,不能启动
-46 网络异常或参数错误
-48 创建任务每日拨号时间段需在9:00-20:00之间
-49 账号未认证
-51 该客户自定义属性不完整
-52 并发数超出账户最大值
-55 话术解绑不允许此类操作
-57 签名不能为空
-58 时间戳不能为空
-59 apikey不能为空
修改AI外呼任务
删除任务

意见反馈

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

 

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 taskStop() {
    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 Integer jobId = "{{jobId}}"; //Your job ID
    final String url = baseUrl.concat("/taskStop");
    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)
            .set("jobId", jobId)
            .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/taskStop";
$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);

$dataArr['appId'] = $appId;
$dataArr['jobId'] = "{{jobId}}";

$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": null
}