API Center/Query a Single Task Stream

Query a Single Task Stream

GET

https://api.itniotech.com/otp/flow/details/{flowId}

Get the details of the specified task flow through the interface.
Request Parameters
flowId
String
Required
Task Flow ID
Request Sample
Request URL:
    https://api.itniotech.com/otp/flow/details/1
Request Method: 
    GET
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Response Parameters
Parameters Description Type
status Status code, 0 is successful, other failures refer to description of status code String
reason The reason for the failure String String
data Response parameter details JSONObject
flowId Task flow ID Int
name Template name, 4-32 characters, no duplicates allowed under user String
flow Task flow node JSONArray
waitingTime Waiting time(s) 30-120 Int
status Status 1 send failure (send failure/report failure), 2 unchecked (including check failure) Int
channel Channel type [sms, call] String
channelCut Whether to switch the channel to send (0 switch 1 do not switch) default 0 Int
Response Status Code
status Description
0 success
-1 Authentication error
-2 Restricted IP access
-16 Timestamp expires
-18 Port program unusual
-22 Parameter exception
Update Task Flow
Query All Task Flow

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

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

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

    final int flowId = "{{flowId}}";
    final String url = baseUrl.concat("/flow/details/").concat(String.valueOf(flowId));
    HttpRequest request = HttpRequest.get(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);

    HttpResponse response = request.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";

$flowId = "{{flowId}}";
$url = "https://api.itniotech.com/otp/flow/details/".$flowId;

$timeStamp = time();
$sign = md5($apiKey.$apiSecret.$timeStamp);
$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_CONNECTTIMEOUT, 600);
curl_setopt($ch, CURLOPT_HTTPHEADER,$headers);
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": 0
            }
        ]
    }
}