AIRUDDER API
  1. Workflow
AIRUDDER API
  • Introductions
  • Quick Start
  • Get the Authorization token
    • Token Authentication and Obtain
      POST
  • Error Codes
    • Error Codes
  • Workflow
    • Webhooks of the Info of Predictive Dialer System
      • Webhook of Predictive Dialer Task Status Changes
      • Webhook of Predictive Dialer Contacts Status Changes
      • Webhook of Predictive Dialer Agents Status Changes
    • Create a New WorkFlow Task
      POST
    • Obtain the List of Workflow Templates
      GET
    • Add lists to an workflow task
      POST
    • Update the List Info of Workflow Task
      POST
    • Cancel the processes for a specific list
      POST
    • Notification of Call Completion in Workflow (Debt Collection/Marketing/E-commerce)
      POST
    • Notification of Call Completion in Workflow(Info Check)
      POST
    • Custom API Node Data Push
      POST
    • Verify the Custom API Node Data Push
      POST
    • Stop the Workflow Task
      POST
    • Obtain the Workflow Task List
      GET
    • Obtain the Subtask List of the Workflow
      GET
    • Obtain the Outbound Task List of Workflow
      POST
    • Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)
      POST
    • Obtain the Outbound Task Details of Workflow(Info Check)
      POST
    • Obtain Call Information and Recording Links by callee/caseid and taskid/workflow_id
      GET
    • Obtian Call Information and Recording Link by Call ID
      GET
    • Obtain All the Recordings of a Single Number in the Workflow
      GET
    • Query workflow_id using case_id/callee
      POST
    • Notification for Workflow List Completion
      POST
    • Notification of Workflow Status Change
      POST
    • Obtain the WABA Tasks List of Workflow
      GET
    • Obtain the WABA Task Details of Workflow
      GET
    • Notification of WABA Message Status Alteration in Workflow
      POST
    • Chatbot Session End Notification in Workflow
      POST
  1. Workflow

Create a New WorkFlow Task

Production
Production
POST
/service/cloud/workflow/createinstance
Create a new WorkFlow Task.

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_template_id
integer 
required
Workflow Template ID.
workflow_template_name
string 
optional
workflow template name (choose one from workflow_template_id)
name
string 
required
Task name, non-repeatable, the length is 54 at longest.
workflow_name
string 
optional
workflow task name (choose one from name)
auto_finish
integer 
optional
Whether it is automatically completed or not: 1 = Yes (means the workflow task will automatically end if the end time is not reached after the workflow process is completed); 2 = No (means the workflow task must wait until the set end time to end). The default value is 2, but it is recommended to use 1.
Default:
2
end_time
string 
required
Workflow task end time.
1.When the time reachs the end time, the workflow status will be changed to finished, and all the tasks in the process of the workflow will be marked as finished.
2.In the format of YYYY-MM-DD HH:MM:SS+TIMEZONE. For example: 2022-12-31 12:34:56+07:00.
3.Please provide the TIMEZONE based on the location of your account's business operations. If the TIMEZONE is not specified, we will assume it as +00:00.
holiday_pause
integer 
optional
Whether to pause during holidays: 1 = Yes (means all processes within the workflow task will automatically check if a holiday is encountered at time nodes, and if it is a holiday, it will be paused for one day); 2 = No (means the holiday pause function is not used). The default value is 2, and holidays are configured on the web portal.
Default:
2
holiday_pause_category
array [object {2}] 
optional
Holiday classification for pausing execution. This data is required if the value of "holiday_pause" is 1.
type
string 
optional
Holiday types are divided into four categories:
1.Working Days
2.Weekends
3.Statutory Holiday
4.Custom Holiday
Among them, Working Days, Weekends, and Statutory Holiday are automatically generated by the system. Custom Holiday needs to be managed on the web portal.
group
array[string]
optional
When the type is selected as Custom Holiday, you need to fill in the "group" field, which represents the custom holiday group in the calendar. For example: ["11.11"]. The group name is customized by you during the management of custom holidays on the web portal.
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_template_id": 1,
  "name": "workflow-test-1",
  "auto_finish": 1,
  "end_time": "2022-10-30 05:05:14+08:00",
  "holiday_pause": 2,
  "details": [
    {
      "callee": "+8612345678",
      "platform": "platform-name",
      "variables": {
        "customer_name": "test-user1",
        "borrow_total_money": "12000",
        "borrow_money": "10000",
        "due_date": "2022-10-10",
        "borrowed_date": "2022-10-08",
        "extra_a": "hello world",
        "gender": "male",
        "comments": "comments "
      },
      "caseid": "test-caseid"
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.airudder.com/service/cloud/workflow/createinstance' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_template_id": 1,
    "name": "workflow-test-1",
    "auto_finish": 1,
    "end_time": "2022-10-30 05:05:14+08:00",
    "holiday_pause": 2,
    "details": [
        {
            "callee": "+8612345678",
            "platform": "platform-name",
            "variables": {
                "customer_name": "test-user1",  
                "borrow_total_money": "12000",
                "borrow_money": "10000",
                "due_date": "2022-10-10",
                "borrowed_date": "2022-10-08",
                "extra_a": "hello world",
                "gender": "male",
                "comments": "comments "
            },
            "caseid": "test-caseid"
        }
    ]
}'

Responses

🟢200success
application/json
Body
data
object 
required
 workflow_id 
string 
required
status
enum<string> 
required
Allowed value:
OK
code
enum<integer> 
required
Allowed values:
200403500401
Example
{
  "data": {
    "workflow_id": "f3696213b60c4debae668f4defd1e60d"
  },
  "status": "OK",
  "code": 200
}
🟢200error1
🟢200error2
Modified at 2024-05-27 10:22:16
Previous
Webhook of Predictive Dialer Agents Status Changes
Next
Obtain the List of Workflow Templates
Built with