Webhook of Predictive Dialer Contacts 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 Contacts 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 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_id

string

必需

Unique ID of Workflow Task

workflow_name

string

必需

Workflow Name

nodetask_id

string

必需

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

nodetask_name

string

必需

pds

object

必需

type

string

必需

默认值:

ContactStatus

body

object

必需

示例

{
  "workflow_id": "2b6951a25b434657b94d4d60d96fcf18",
  "workflow_name": "pds-test20",
  "nodetask_id": "5abeb76b414c4b8da455a253dac7bd86",
  "nodetask_name": "PDS1_cc18c2",
  "pds": {
    "type": "ContactStatus",
    "body": {
      "taskId": "9751a67700274a24b650334587653de6",
      "taskName": "wf_pds_task_e6480fad94f24b9ab9cc671e2eb21b03",
      "groupName": "group1",
      "state": "HANGUP",
      "phoneNumber": "+8610081",
      "callid": "48ff2faa9de34c0387eb688468d563a5",
      "contactName": "",
      "address": "",
      "info1": "",
      "info2": "",
      "info3": "",
      "remark": "",
      "hangupReason": 8,
      "timestamp": "1668998317236",
      "privateData": "45285aaae6fa40fea043c21ab1a38a61",
      "recLink": ""
    }
  }
}

示例代码

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": "ContactStatus",
    "body": {
      "taskId": "9751a67700274a24b650334587653de6",
      "taskName": "wf_pds_task_e6480fad94f24b9ab9cc671e2eb21b03",
      "groupName": "group1",
      "state": "HANGUP",
      "phoneNumber": "+8610081",
      "callid": "48ff2faa9de34c0387eb688468d563a5",
      "contactName": "",
      "address": "",
      "info1": "",
      "info2": "",
      "info3": "",
      "remark": "",
      "hangupReason": 8,
      "timestamp": "1668998317236",
      "privateData": "45285aaae6fa40fea043c21ab1a38a61",
      "recLink": ""
    }
  }
}'

返回响应

🟢200Success

application/json

Body

object {0}

示例

{}

修改于 2023-01-05 06:19:01

Webhook of Predictive Dialer Task Status Changes

Webhook of Predictive Dialer Agents Status Changes