API中心/新增任务流
 
 

新增任务流

POST
https://api.itniotech.com/otp/flow/add
通过接口创建任务流。
 
请求参数
参数 说明 是否必填 类型
name 模板名称，4-32字符，用户下不允许重复 是 String
flow 任务流节点 是 JSONArray
waitingTime 等待时间（s）30-120 是 Int
status 1发送失败（发送失败/报告失败）2未校验（包括校验失败） 是 Int
channel 通道类型 [sms, call] 是 String
channelCut 是否切换通道发送（0切换1不切换）默认0 否 Int
 
请求示例
Request URL: 
    https://api.itniotech.com/otp/flow/add
Request Method: 
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "name": "name",
    "flow": [
        {
            "waitingTime": 30,
            "status": 1,
            "channel": "sms",
            "channelCut": 1
        }
    ]
}
 
响应参数
参数 说明 类型
status 状态码，0成功，其他失败参见响应状态码说明 String
reason 失败原因说明 String
data 响应参数详情 JSONObject
flowId 任务流ID Int
name 模板名称，4-32字符，用户下不允许重复 String
flow 任务流节点 JSONArray
waitingTime 等待时间（s）30-120 Int
status 1发送失败（发送失败/报告失败）2未校验（包括校验失败） Int
channel 通道类型 [sms, call] String
channelCut 是否切换通道发送（0切换1不切换）默认0 Int
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-2 ip限制
-16 时间戳过期
-18 系统异常
-20 数据已存在
-22 参数异常
验证码记录详情
更新任务流

意见反馈

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

 

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.JSONUtil;

 import java.time.LocalDateTime;
 import java.time.ZoneId;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;

private void addFlow() {
    final String baseUrl = "https://api.itniotech.com/otp";
    final String apiKey = "your api key";
    final String apiPwd = "your api secret";

    final String url = baseUrl.concat("/flow/add");
    final String name = "name";
    final Map flow = new HashMap<>();
    flow.put("waitingTime", 30);
    flow.put("status", 1);
    flow.put("channel", "sms");
    flow.put("channelCut", 1);

    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)
            .header("Timestamp", datetime)
            .header("Api-Key", apiKey);

    final String params = JSONUtil.createObj()
            .set("name", name)
            .set("flow", Arrays.asList(flow))
            .toString();
    HttpResponse response = request.body(JSONUtil.toJsonStr(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";

$url = "https://api.itniotech.com/otp/flow/add";
$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);

$dataArr['name'] = 'name';
$dataArr['flow'] = array(
    array(
        "waitingTime"=>30,
        "status"=>1,
        "channel"=>'sms',
        "channelCut"=>1
    )
);

$data = json_encode($dataArr);
$headers[] = 'Content-Type: application/json;charset=UTF-8';
$headers[] = "Sign: $sign";
$headers[] = "Timestamp: $timeStamp";
$headers[] = "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": {
        "flowId": 1,
		"name": "name",
		"flow": [
			{
                "waitingTime": 30,
				"status": 1,
				"channel": "sms",
				"channelCut": 1
			}
		]
	}
}