Webhook of Predictive Dialer Task Status Changes

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.

请求参数

Header 参数

Body 参数application/json

示例

{
  "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
    }
  }
}

请求示例代码

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": "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
    }
  }
}'

返回响应

🟢200Success

application/json

Body

示例

{}

修改于 2023-04-25 11:04:47

API Interface with AES Encryption/Decryption - Example

Webhook of Predictive Dialer Agents Status Changes