Add lists to an workflow task

Add new lists to an existing workflow task. This is applicable when the call/reach process for the lists is the same, and the lists are generated by your business system in close succession. Please note the following when adding lists:
1.Pay attention to the current status of the original workflow task. If it has already ended or been canceled, it will not be possible to add new lists.
2.Also, consider the end time of the original workflow task. If the end time is approaching, it may result in the newly added lists not completing all the expected processes as intended.

Request

Header Params

Authorization

string

required

Default:

Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU

Content-Type

string

required

Default:

application/json

User-Agent

string

optional

Default:

Airudder

Body Params application/json

workflow_id

string

required

The workflow_id returned when the workflow was created.

details

array [object {5}]

required

The list information for the execution flow within the workflow. Each task can contain up to 10,000 numbers.

callee

string

required

Customer phone number with the prefix '+' and international dialing code, for example, "+6212345678" or "+5212345678", etc.

platform

string

required

Platform name, should not exceed 40 characters, please contact us for a list of available platform names.

caseid

string

optional

List unique identifier, typically used for uploading unique identifiers with business meanings, such as account ID, user ID, order ID, etc. This facilitates data storage or data analysis based on this field.

variables

object

required

Workflow task variables. Each workflow task has different variables, including robot variables, SMS variables, WhatsApp variables, and workflow-specific process variables.
1.The key is the variable name provided by us, and the value is the variable content of type String.
2.The list provides examples of common robot variables in the debt collection scenario (for Telmarketing and E-commerce scenarios, only customer_name is required, while other fields are optional. Please upload according to the requirements of the robot). For specific variables used, please contact us to obtain them.
3.For other custom variables not listed, please upload them in the key-value format.

pds_variables

object

optional

PDS variables, applicable for executing non-real-time transfer-to-human processes within the workflow. Please contact us to obtain the specific variable keys.

Example

{
    "workflow_id": "e958b74daf3e4c1c9e438d82db4c9999",
    "details": [
        {
            "variables": {
                "customer_name": "test-user1",
                "borrow_total_money": "100",
                "borrowed_amount": "80",
                "due_date":"2022-09-08",
                "borrowed_date":"2022-09-01"
                
            },
            "platform": "TEMP1",
            "callee": "+8618116123456",
            "caseid": "test-caseid-1"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200success

application/json

Body

data

object

required

workflow_id

string

required

status

enum<string>

required

Allowed value:

code

enum<integer>

required

Allowed values:

200403500401

Examples

Example of SuccessExamle of AbnormalExamle of Abnormal

{
    "data": {
        "workflow_id": "9eea913e93b84807a88c611111111"
    },
    "status": "OK",
    "code": 200
}

🟢200Error

🟢200error