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

Notification of Workflow Status Change

Production
Production
POST
The integrating party should provide this URL for configuration by our side.
Notify the integrating party proactively when the workflow status changes to "cancelled" and "finished".

Request

Header Params
Content-Type
string 
required
Default:
application/json
User-Agent
string 
optional
Default:
Airudder
Body Params application/json
workflow_id
string 
required
workflow_name
string 
required
status
string 
required
The workflow status is "cancelled" if it is canceled, and "finished" if it is completed.
actions
array [object {5}] 
required
nodetask_id
string 
required
The ID of the triggered nodes in the workflow.
nodetask_name
string 
required
The name of the triggered nodes in the workflow.
node_type
string 
required
The types of the triggered nodes in the workflow, such as "call" for outbound nodes and "sms" for SMS nodes.
task_id
string 
optional
The ID of the outbound task, if the node is an outbound node.
task_status
string 
optional
The status of the outbound task, if the node is an outbound node.
Example
{
	"workflow_id": "ea1cb50d19******b3c257bb6a0935b5",
	"workflow_name": "052******shed2",
	"status": "finished",
	"actions": [
		{
			"nodetask_id": "dc9d08ce1f0******b2829274acf",
			"nodetask_name": "SMS1_de09d6",
			"node_type": "sms"
		},
		{
			"nodetask_id": "6df98bf0878******dd48b18f932f1",
			"nodetask_name": "Voicebot Call2_c3d53d",
			"node_type": "call",
			"task_id": "d5f570c5ca5c******030f8f0bd6",
			"task_status": "finished"
		},
		{
			"nodetask_id": "a1aafaafb******32d7e0b8af",
			"nodetask_name": "Voicebot Call1_a9c2ad",
			"node_type": "call",
			"task_id": "e5173ab553e******93b28edd5ee",
			"task_status": "finished"
		}
	]
}

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 'The integrating party should provide this URL for configuration by our side.' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
	"workflow_id": "ea1cb50d19******b3c257bb6a0935b5",
	"workflow_name": "052******shed2",
	"status": "finished",
	"actions": [
		{
			"nodetask_id": "dc9d08ce1f0******b2829274acf",
			"nodetask_name": "SMS1_de09d6",
			"node_type": "sms"
		},
		{
			"nodetask_id": "6df98bf0878******dd48b18f932f1",
			"nodetask_name": "Voicebot Call2_c3d53d",
			"node_type": "call",
			"task_id": "d5f570c5ca5c******030f8f0bd6",
			"task_status": "finished"
		},
		{
			"nodetask_id": "a1aafaafb******32d7e0b8af",
			"nodetask_name": "Voicebot Call1_a9c2ad",
			"node_type": "call",
			"task_id": "e5173ab553e******93b28edd5ee",
			"task_status": "finished"
		}
	]
}'

Responses

🟢200success
application/json
Body
object {0}
Example
{}
Modified at 2024-05-28 10:54:50
Previous
Notification for Workflow List Completion
Next
Obtain the WABA Tasks List of Workflow
Built with