AIRUDDER API
  1. Webhooks of the Info of Predictive Dialer System
AIRUDDER API
  • Introductions
  • Quick Start
  • Get the Authorization token
    • Token Authentication and Obtain
  • Error Codes
    • Error Codes
  • Workflow
    • Webhooks of the Info of Predictive Dialer System
      • Webhook of Predictive Dialer Task Status Changes
        POST
      • Webhook of Predictive Dialer Contacts Status Changes
        POST
      • Webhook of Predictive Dialer Agents Status Changes
        POST
    • 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. Webhooks of the Info of Predictive Dialer System

Webhook of Predictive Dialer Task Status Changes

Production
Production
POST
The counterparty provides us with the URL to configure in the workflow
The example in this unit shows the webhook info when the Task Status changes.
When the call has been dialed (either answered or dialed), no matter it is answered or not, the data of the call in the task will be pushed to the counterparty. If the URL responds abnormally, we will retry after 1-min interval. The maximum are 5 tries, no further notifications will be pushed.
When the task is executing, each time the status change(Tasks, Contacts or Agents), the webhook info of the Predictive Dialer will be pushed in three different formats.

Request

Header Params
Content-Type
string 
required
Default:
application/json
User-Agent
string 
optional
Default:
Airudder
Body Params application/json
workflow_id
string 
required
Unique ID of Workflow Task
workflow_name
string 
required
Workflow Name
nodetask_id
string 
required
Workflow Node ID, no need to pay attention to.
nodetask_name
string 
required
pds
object 
required
type
string 
required
Default:
TaskStatus
body
object 
required
Example
{
  "workflow_id": "2b6951a25b434657b94d4d60d96fcf18",
  "workflow_name": "pds-test20",
  "nodetask_id": "5abeb76b414c4b8da455a253dac7bd86",
  "nodetask_name": "PDS1_cc18c2",
  "pds": {
    "type": "TaskStatus",
    "body": {
      "taskId": "9751a67700274a24b650334587653de6",
      "taskName": "wf_pds_task_e6480fad94f24b9ab9cc671e2eb21b03",
      "groupName": "group1",
      "startTime": "2022-11-21T02:37:50Z",
      "actualStartTime": "2022-11-21T02:38:02Z",
      "endTime": "",
      "totalNumber": 3,
      "dialedNumber": 0,
      "answeredNumber": 0,
      "talkedNumber": 0,
      "registeredCount": 1,
      "state": "Running",
      "displayTalkResult": "Agree",
      "talkResultCount": 0
    }
  }
}

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 counterparty provides us with the URL to configure in the workflow' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workflow_id": "2b6951a25b434657b94d4d60d96fcf18",
  "workflow_name": "pds-test20",
  "nodetask_id": "5abeb76b414c4b8da455a253dac7bd86",
  "nodetask_name": "PDS1_cc18c2",
  "pds": {
    "type": "TaskStatus",
    "body": {
      "taskId": "9751a67700274a24b650334587653de6",
      "taskName": "wf_pds_task_e6480fad94f24b9ab9cc671e2eb21b03",
      "groupName": "group1",
      "startTime": "2022-11-21T02:37:50Z",
      "actualStartTime": "2022-11-21T02:38:02Z",
      "endTime": "",
      "totalNumber": 3,
      "dialedNumber": 0,
      "answeredNumber": 0,
      "talkedNumber": 0,
      "registeredCount": 1,
      "state": "Running",
      "displayTalkResult": "Agree",
      "talkResultCount": 0
    }
  }
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2023-01-05 06:19:01
Previous
Error Codes
Next
Webhook of Predictive Dialer Contacts Status Changes
Built with