Notification of Call Completion in Workflow(Info Check)

When the phone call for a task is completed (connected or reaching the maximum dialing attempts), whether connected or not, notify the integrating party of the call data.
For example, task1 have three numbers (number1, number2, and number3). When the task starts dialing, if number1 is connected, the callback for number1's call information should be initiated. If number2 and number3 are not connected, the system should perform the configured number of redial attempts until the call is connected or the maximum attempts are reached, and then initiate the callback.

If the provided URL encounters an exception, our system will retry at 1-minute intervals, for a maximum of 5 retries. After 5 failed attempts, no further notifications will be sent. Please respond within 10 seconds upon receiving the data and handle the data storage and subsequent logic asynchronously.

The integrating party needs to provide two parameters for configuration:
URL: The callback address.
KEY: The key used for parameter signing, with the default signature using "airudder".

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_id

string

必需

Workflow uniquely id.

workflow_name

string

必需

Workflow name.

nodetask_id

string

必需

Workflow node details ID, no need to follow.

nodetask_name

string

必需

Workflow node task name.

task_id

string

Task ID.

必需

task_name

string

必需

Task name.

status

enum<string>

必需

枚举值:

createdpendingfinishedcallingcanceledpaused

created_at

string

必需

Task creation time, in account's time zone.

repeat_interval

integer

必需

Repeated call time interval, measured in minutes.

repeat_number

integer

必需

Number of repeated call attempts.

robot_hash

string

必需

Robot hash ID.

robot_method

string

必需

Type of robot used.

sip_line

string

必需

Name of the line used.

schedule_start_time

string

必需

Estimated start time of the task, in account's time zone.

schedule_end_time

string

必需

Estimated end time of the task, in account's time zone.

details

array [object {22}]

必需

1.This is an array structure because concurrent phone calls are made, and there may be cases where phone calls start and end at the same time. Here, notifications will be aggregated. Please refer to the example below.
2.Time zone is in account's time zone.

integer

必需

Phone details ID, no need to follow

callee

string

必需

Called party number.

result

enum<string>

必需

枚举值:

createdpendingfinishedcancelledfailed

result_label

string

必需

Intent Labels, different robots have different intent labels.

duration

integer

必需

Duration of the phone call, measured in seconds.

hangup_type

enum<string>

必需

Hangup Category, initial value is ByRobot.

枚举值:

ByCalleeByRobotCanceled

ring_type

enum<string>

必需

Ring Category, initial value is null.

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

question_answer

array [object {10}]

必需

NerSlots

object

可选

Slot key and value information for the call. (This field varies by country/region. If you need more information, please contact us.)

robot_hash

string

必需

The Robot hash id of the robot use in the call

call_id

string

必需

A unique ID for each call

call_times

integer

必需

Number of calls, which counts the number of dialed call before it is picked up.

call_start_time

string

必需

User connected time, excluding ringing time, in account's time zone.

call_end_time

string

必需

End the call time, in account's time zone.

ring_time

integer

必需

Ring duration of the call. (This field varies by country/region. If you need more information, please contact us.)

talk_round

integer

必需

Conversation rounds. (This field varies by country/region. If you need more information, please contact us.)

redail_call

array [object {8}]

可选

Specific information on redialing within the rounds for the call. (This field varies by country, please contact us if needed.)

intention_description

string

可选

Intent description, different robots have different intent descriptions. (This field varies by country/region. If you need more information, please contact us.)

EventLabel

object

可选

Event labels hit during the call. (This field varies by country, please contact us if needed.)

caller_number

string

可选

Caller's phone number for the call. (This field varies by country/region. If you need more information, please contact us.)

CaseID

string

必需

The unique id of the customer.

Variables

object

必需

Custom variables

示例

{
  "workflow_id": "8e364f6729exxxxxxxxxx5c2d9b2a2c2",
  "workflow_name": "test_wf_call_webhook3",
  "nodetask_id": "5e4e48c5a8axxxxxxxxxxb4ac4b8",
  "nodetask_name": "Voicebot Call1_67554d",
  "task_id": "ea617807492xxxxxxxxxx09c11650",
  "task_name": "wf_test_wf_call_webhook_Voicebot Call1_d01cb6",
  "status": "calling",
  "created_at": "2024-03-11 13:19:52",
  "repeat_interval": 0,
  "repeat_number": 3,
  "robot_hash": "a37e555fxxxxxxxxxxca7ac3575d8",
  "robot_method": "single",
  "sip_line": "CH_SOFTPHONE_Lyntest_HK_LINE",
  "schedule_start_time": "2024-03-11 13:21:27",
  "schedule_end_time": "2024-03-11 13:52:52",
  "details": [
    {
      "id": 2124875281,
      "callee": "+8618xxxxx721",
      "result": "finished",
      "result_label": "E",
      "duration": 43,
      "hangup_type": "ByCallee",
      "ring_type": "normal",
      "question_answer": [
        {
          "question_name": "Q0",
          "answer": "/",
          "answer_text": "",
          "status": "Completed",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": "\\u610f\\u613f\\u786e\\u8ba4 Willingness Check",
          "question_type": "whether",
          "whether_answer": "Hangup"
        },
        {
          "question_name": "Q1",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": "\\u59d3\\u540d\\u786e\\u8ba4 NameCheck",
          "question_type": "whether",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q2",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": "\\u8d37\\u6b3e\\u4eba\\u786e\\u8ba4 BorrowerCheck",
          "question_type": "whether",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q3",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "200",
          "verification_results": "/",
          "question_content": "CURP\\u6838\\u9a8c CURP Verification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q3N",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "200",
          "verification_results": "/",
          "question_content": "CURP\\u518d\\u6b21\\u6838\\u9a8c CURP Reverification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q4",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "1101",
          "verification_results": "/",
          "question_content": "\\u751f\\u65e5\\u6838\\u9a8c DoB Verification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q4N",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "1101",
          "verification_results": "/",
          "question_content": "\\u751f\\u65e5\\u518d\\u6b21\\u6838\\u9a8c DoB Reverification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q5",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "200",
          "verification_results": "/",
          "question_content": "CURP2\\u4f4d\\u6838\\u9a8c CURP Verification for 2 character",
          "question_type": "open",
          "whether_answer": "Skip"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "Transfer",
        "PaymentTime": "Time_0"
      },
      "robot_hash": "a37e555fxxxxxxxxxxa7ac3575d8",
      "call_id": "ic1689265xxxxxxxxxxfe7b7da5b5",
      "call_times": 2,
      "call_start_time": "2024-03-11 13:24:29",
      "call_end_time": "2024-03-11 13:25:12",
      "ring_time": 2,
      "talk_round": 3,
      "redail_call": [
        {
          "call_id": "icea62exxxxxxxxxx70982a5c2f7",
          "call_start_time": "2024-03-11 13:23:34",
          "ring_type": "normal",
          "ring_time": 3,
          "hangup_type": "ByCallee",
          "result_label": "F",
          "callee_number": "+861xxxxxxxxxx5721",
          "caller_number": "+95xxxxxxxxxx088"
        }
      ],
      "intention_description": "No Answer",
      "EventLabel": {
        "A0": "A0",
        "Correct_Person": "identity_correct_person",
        "Request_Installment": "action_item_request_installment"
      },
      "caller_number": "+95xxxxxxxxxx088",
      "CaseID": "",
      "Variables": {
        "DoB": "1101",
        "CURP": "200",
        "name": "lyn",
        "gender": "male"
      }
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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": "8e364f6729exxxxxxxxxx5c2d9b2a2c2",
  "workflow_name": "test_wf_call_webhook3",
  "nodetask_id": "5e4e48c5a8axxxxxxxxxxb4ac4b8",
  "nodetask_name": "Voicebot Call1_67554d",
  "task_id": "ea617807492xxxxxxxxxx09c11650",
  "task_name": "wf_test_wf_call_webhook_Voicebot Call1_d01cb6",
  "status": "calling",
  "created_at": "2024-03-11 13:19:52",
  "repeat_interval": 0,
  "repeat_number": 3,
  "robot_hash": "a37e555fxxxxxxxxxxca7ac3575d8",
  "robot_method": "single",
  "sip_line": "CH_SOFTPHONE_Lyntest_HK_LINE",
  "schedule_start_time": "2024-03-11 13:21:27",
  "schedule_end_time": "2024-03-11 13:52:52",
  "details": [
    {
      "id": 2124875281,
      "callee": "+8618xxxxx721",
      "result": "finished",
      "result_label": "E",
      "duration": 43,
      "hangup_type": "ByCallee",
      "ring_type": "normal",
      "question_answer": [
        {
          "question_name": "Q0",
          "answer": "/",
          "answer_text": "",
          "status": "Completed",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": "\\u610f\\u613f\\u786e\\u8ba4 Willingness Check",
          "question_type": "whether",
          "whether_answer": "Hangup"
        },
        {
          "question_name": "Q1",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": "\\u59d3\\u540d\\u786e\\u8ba4 NameCheck",
          "question_type": "whether",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q2",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": "\\u8d37\\u6b3e\\u4eba\\u786e\\u8ba4 BorrowerCheck",
          "question_type": "whether",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q3",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "200",
          "verification_results": "/",
          "question_content": "CURP\\u6838\\u9a8c CURP Verification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q3N",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "200",
          "verification_results": "/",
          "question_content": "CURP\\u518d\\u6b21\\u6838\\u9a8c CURP Reverification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q4",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "1101",
          "verification_results": "/",
          "question_content": "\\u751f\\u65e5\\u6838\\u9a8c DoB Verification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q4N",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "1101",
          "verification_results": "/",
          "question_content": "\\u751f\\u65e5\\u518d\\u6b21\\u6838\\u9a8c DoB Reverification",
          "question_type": "open",
          "whether_answer": "Skip"
        },
        {
          "question_name": "Q5",
          "answer": "/",
          "answer_text": "",
          "status": "Skip",
          "answer_text_slot": "/",
          "var": "200",
          "verification_results": "/",
          "question_content": "CURP2\\u4f4d\\u6838\\u9a8c CURP Verification for 2 character",
          "question_type": "open",
          "whether_answer": "Skip"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "Transfer",
        "PaymentTime": "Time_0"
      },
      "robot_hash": "a37e555fxxxxxxxxxxa7ac3575d8",
      "call_id": "ic1689265xxxxxxxxxxfe7b7da5b5",
      "call_times": 2,
      "call_start_time": "2024-03-11 13:24:29",
      "call_end_time": "2024-03-11 13:25:12",
      "ring_time": 2,
      "talk_round": 3,
      "redail_call": [
        {
          "call_id": "icea62exxxxxxxxxx70982a5c2f7",
          "call_start_time": "2024-03-11 13:23:34",
          "ring_type": "normal",
          "ring_time": 3,
          "hangup_type": "ByCallee",
          "result_label": "F",
          "callee_number": "+861xxxxxxxxxx5721",
          "caller_number": "+95xxxxxxxxxx088"
        }
      ],
      "intention_description": "No Answer",
      "EventLabel": {
        "A0": "A0",
        "Correct_Person": "identity_correct_person",
        "Request_Installment": "action_item_request_installment"
      },
      "caller_number": "+95xxxxxxxxxx088",
      "CaseID": "",
      "Variables": {
        "DoB": "1101",
        "CURP": "200",
        "name": "lyn",
        "gender": "male"
      }
    }
  ]
}'

Notification of Call Completion in Workflow(Info Check)

请求参数

示例代码

返回响应