Workflow外呼电话拨打结束通知 (信审示例)

当任务的电话拨打结束时(接通或者完成拨打次数)，不管接通还是未接通，主动通知对接方该任务的此电话拨打数据。

例如:任务task1中含有3个号码(number1、number2、number3)。
当任务开始拨打时,number1被接通,则此时number1进行电话信息回调; number2、number3未接通,则按照任务中配置的重拨次数进行拨打,直到接通或者完成重拨次数后进行回调。

如果此url响应异常，我方会间隔1分钟进行重试，最多5次重试失败后不再进行通知。请在收到数据10s内响应，同时异步处理数据存储及后续逻辑。

对接方需要提供两个参数给我方配置：
URL 回调地址
KEY 参数签名用的KEY，默认使用airudder签名。

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_id

string

必需

workflow 任务唯一ID

workflow_name

string

必需

workflow 任务名

nodetask_id

string

必需

workflow 外呼节点 ID

nodetask_name

string

必需

workflow 外呼节点名称

task_id

string

任务ID

必需

task_name

string

必需

由workflow 自动创建的外呼任务名称

status

enum<string>

任务状态

必需

枚举值:

createdpendingfinishedcallingcanceledpaused

created_at

string

必需

任务创建时间，为账户时区时间

repeat_interval

integer

必需

重复呼叫时间间隔，单位是分钟

repeat_number

integer

重复呼叫次数

必需

robot_hash

string

必需

使用的机器人的hash id

robot_method

string

使用的机器人的类型

必需

sip_line

string

使用的线路名称

必需

schedule_start_time

string

必需

任务的预计开始时间，时区为客户所在地区时间。

schedule_end_time

string

必需

任务的预计结束时间，时区为客户所在地区时间。

details

array [object {22}]

必需

1.这里是一个数组，之所以采用数组结构，是因为电话并发拨打，会存在电话拨打同时结束的情况，这里会聚合通知，具体看下面的示例
2.时区为客户所在地区时间。

integer

必需

callee

string

必需

电话号码，带有前缀'+'和国际区号，例如“+6212341234”称列表。

result

enum<string>

电话状态

必需

枚举值:

createdpendingfinishedcancelledfailed

result_label

string

必需

通话结果标签，根据机器人不同通话结果有不同的含义。

duration

integer

必需

该通电话的通话时长，单位是s

hangup_type

enum<string>

必需

挂断分类，初始值为ByRobot

枚举值:

ByCalleeByRobotCanceled

ring_type

enum<string>

必需

响铃分类，初始值为null

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

question_answer

array [object {10}]

必需

EventLabel

object

可选

呼叫结果多标签。（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

robot_hash

string

必需

robotid hash值。

call_id

string

呼叫唯一id

必需

call_times

integer

必需

当前轮次内该名单的拨打总次数。

call_start_time

string

必需

该通电话的用户接通时间，不包含响铃时长。时区为客户所在地区时间。

call_end_time

string

必需

该通电话的拨打结束时间。时区为客户所在地区时间

ring_time

integer

必需

呼叫的振铃持续时间。

talk_round

integer

必需

通话回合。（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

redail_call

array [object {14}]

可选

本轮通话重拨的详细信息。（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

CaseID

string

客户唯一编号

必需

Variables

object

可选

用户上传的变量信息。（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

NerSlots

object

可选

该通电话的槽值信息（此字段因国家/地区而异，如有需要，请联系我们）

intention_description

string

可选

意图描述，不同的机器人的不同意图描述均不一样。此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

caller_number

string

可选

通话的主叫号码（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

示例

{
  "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 '对接方提供此url交给我方配置' \
--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"
            }
        }
    ]
}'

Workflow外呼电话拨打结束通知 (信审示例)

请求参数

示例代码

返回响应