Webhook of Predictive Dialer Agents Status Changes

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 Agents 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

ID of Workflow Node, no need to pay attention to.

nodetask_name

string

required

pds

object

required

type

string

required

Default:

AgentStatus

body

object

required

Example

{
  "workflow_id": "a661808d1a554bcba766a7497cd6ee38",
  "workflow_name": "pds-test-1",
  "nodetask_id": "1bc79ad640404b2db9dcec510ed43570",
  "nodetask_name": "PDS1_6f3983",
  "pds": {
    "type": "AgentStatus",
    "body": {
      "agentName": "agent-test-1",
      "registerState": "Registered",
      "State": "TALKRESULT",
      "taskId": "24d5389573c54d4d9776aad8213dc57a",
      "taskName": "wf_pds_task_9ab1a02b4eeb44c8b8af2efac8e87f6d",
      "groupName": "group2",
      "phoneNumber": "+86123123",
      "callid": "7b26855b20ea4f1b8fa0f78675412345",
      "contactName": "",
      "address": "",
      "info1": "",
      "info2": "",
      "info3": "",
      "remark": "",
      "privateData": "e3740a60419f4ddbb3eb3ea81012345",
      "timestamp": "1668739507150",
      "talkResultLabel": "Have_Intention",
      "curDayCallCount": 0,
      "curDayCallDuration": 0,
      "curDayTalkResults": [
        {
          "talkResult": "Have_Intention",
          "count": 1
        },
        {
          "talkResult": "Have_No_Intention",
          "count": 0
        },
        {
          "talkResult": "Voicemail",
          "count": 0
        },
        {
          "talkResult": "Have_Loan_Payday",
          "count": 0
        },
        {
          "talkResult": "Agree",
          "count": 0
        }
      ],
      "displayTalkResult": "Agree",
      "isConcealCallee": "",
      "curDayOnlineDuration": 3155,
      "curDayRestDuration": 0,
      "curWaitingCallCount": 0,
      "groupUnallocatedCall": 0,
      "earliestCallWaitTime": 0,
      "threewayState": "",
      "threewayAccount": ""
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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": "a661808d1a554bcba766a7497cd6ee38",
  "workflow_name": "pds-test-1",
  "nodetask_id": "1bc79ad640404b2db9dcec510ed43570",
  "nodetask_name": "PDS1_6f3983",
  "pds": {
    "type": "AgentStatus",
    "body": {
      "agentName": "agent-test-1",
      "registerState": "Registered",
      "State": "TALKRESULT",
      "taskId": "24d5389573c54d4d9776aad8213dc57a",
      "taskName": "wf_pds_task_9ab1a02b4eeb44c8b8af2efac8e87f6d",
      "groupName": "group2",
      "phoneNumber": "+86123123",
      "callid": "7b26855b20ea4f1b8fa0f78675412345",
      "contactName": "",
      "address": "",
      "info1": "",
      "info2": "",
      "info3": "",
      "remark": "",
      "privateData": "e3740a60419f4ddbb3eb3ea81012345",
      "timestamp": "1668739507150",
      "talkResultLabel": "Have_Intention",
      "curDayCallCount": 0,
      "curDayCallDuration": 0,
      "curDayTalkResults": [
        {
          "talkResult": "Have_Intention",
          "count": 1
        },
        {
          "talkResult": "Have_No_Intention",
          "count": 0
        },
        {
          "talkResult": "Voicemail",
          "count": 0
        },
        {
          "talkResult": "Have_Loan_Payday",
          "count": 0
        },
        {
          "talkResult": "Agree",
          "count": 0
        }
      ],
      "displayTalkResult": "Agree",
      "isConcealCallee": "",
      "curDayOnlineDuration": 3155,
      "curDayRestDuration": 0,
      "curWaitingCallCount": 0,
      "groupUnallocatedCall": 0,
      "earliestCallWaitTime": 0,
      "threewayState": "",
      "threewayAccount": ""
    }
  }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2023-01-05 06:19:01

Webhook of Predictive Dialer Contacts Status Changes

Create a New WorkFlow Task