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.Connected calls will be notified immediately after completion; all calls that have been dialed but not connected will be aggregated and notified after the task ends.
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 参数

Body 参数application/json

示例

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

请求参数

请求示例代码

返回响应