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 外呼节点名称

TaskID

string

任务ID

必需

TaskName

string

必需

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

Sign

string

必需

md5签名值，对接方可以验证此签名后在对任务ID做后续处理，也可以不做验证。
签名规则：TaskID+KEY的utf-8编码的md5计算结果的16进制小写值。例如TaskID=ac23fa05005e59b92e0b8a19fa5faf07 KEY=airudder
计算公式=md5(TaskID+KEY).hexdigest()
md5值=4d6017151d678e816c678d90e56e6e28

Details

array [object {36}]

必需

1.这里是一个数组，之所以采用数组结构，是因为电话并发拨打，会存在电话拨打同时结束的情况，这里会聚合通知，具体看下面的示例
2. 注意：返回时间为UTC +00:00时区

integer

必需

电话细节ID，无需关注

RobotID

string

机器人 id

必需

CalleeName

string

必需

CalleeGender

string

必需

CalleeNumber

string

必需

CallStartTime

string

必需

返回时间为UTC +00:00时区。已接通的电话，此字段代表用户接通时间，不包含响铃时间。未接通的电话，此字段与CallEndTime一致。

CallEndTime

string

必需

结束通话时间。返回时间为UTC +00:00时区。

Status

enum<string>

电话状态

必需

枚举值:

createdpendingfinishedcancelledfailed

Intention

string

必需

意图标签，不同机器人的意图标签均不一样

intention_description

string

可选

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

CallID

string

呼叫的唯一 ID。

必需

CallTimes

integer

必需

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

Comments

string

必需

BorrowedDate

string

可选

机器人变量，与创建时上传的相同。（仅催收场景有此字段）

DueDate

string

可选

机器人变量，与创建时上传的相同。（仅催收场景有此字段）

BorrowedAmount

string

可选

机器人变量，与创建时上传的相同。（仅催收场景有此字段）

TotalOwingAmount

string

可选

机器人变量，与创建时上传的相同。（仅催收场景有此字段）

CurrencyUnit

string

可选

机器人变量，与创建时上传的相同。（仅催收场景有此字段）

PlatformName

string

必需

机器人平台名，机器人制作时我方会与您方确定平台名称。

RingType

enum<string>

必需

响铃分类，初始值为null

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

HangupType

enum<string>

必需

挂断分类，初始值为ByRobot

枚举值:

ByCalleeByRobotCanceled

ExtraA

string

可选

机器人变量，与创建时上传的相同。

ExtraB

string

可选

机器人变量，与创建时上传的相同。

ExtraC

string

可选

机器人变量，与创建时上传的相同。

NerSlots

object

可选

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

AsrResult

array [object {3}]

可选

该通电话的机器人和用户对话文本（此字段因国家而异，如有需要，请联系我们）

AskWhatsAPP

string

可选

该通电话是否同意WHATSAPP联系（此字段因国家而异，如有需要，请联系我们）

AsrPTP

string

可选

对话过程中用户提到承诺还款时间的语音转成的文本”和这句话在对话中的时间。（该字段因国家而异，如有需要，请联系我们）

Multi_intention

object

可选

该通电话命中的多标签（此字段将废弃，由EventLabel取代）

EventLabel

object

可选

该通电话命中的事件标签（此字段因国家而异，如有需要，请联系我们）

RingTime

integer

可选

呼叫的振铃持续时间。（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

TalkRound

integer

可选

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

RedailCall

array [object {8}]

可选

该通电话在轮次内重拨的具体信息（此字段因国家而异，如有需要，请联系我们）

CaseID

string

客户唯一编号

必需

Variables

object

必需

机器人变量，与创建时上传的相同。

caller_number

string

可选

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

示例

{
  "workflow_id": "16e0660e6cxxxxxxxxxxxxxxxx0abfe0e191",
  "workflow_name": "test_wf_call_webhook1",
  "nodetask_id": "4d308b4ed6xxxxxxxxed6a76e15d",
  "nodetask_name": "Voicebot Call1_f405f7",
  "TaskID": "490d5ec3c1xxxxxxxx2b759b5b",
  "TaskName": "wf_test_wf_call_webhook_Voicebot Call1_26bcf0",
  "Sign": "a395ce1acxxxxxxxx7bab53f5",
  "Details": [
    {
      "id": 2123875204,
      "RobotID": "4585",
      "CalleeName": "WILL SMITH",
      "CalleeGender": "",
      "CalleeNumber": "+86xxxxxxxx721",
      "CallStartTime": "2024-03-11T03:20:30Z",
      "CallEndTime": "2024-03-11T03:20:56Z",
      "Status": "finished",
      "Intention": "E",
      "CallID": "cad907xxxxxxxx35644a",
      "CallTimes": 2,
      "Comments": "7777777.0",
      "BorrowedDate": "2024-02-01",
      "DueDate": "2024-03-02",
      "BorrowedAmount": "20000.00",
      "TotalOwingAmount": "20310.00",
      "CurrencyUnit": "USD",
      "PlatformName": "AIRUDDER",
      "RingType": "normal",
      "HangupType": "ByRobot",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "halo (jeda 1-2 detik) selamat pagi",
          "text": ""
        },
        {
          "time": "00:00:03",
          "robottext": "Apa boleh minta waktunya sebentar?",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "Halo",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "mengapa tidak berbicara?",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "Halo? Apa suara saya terdengar?",
          "text": ""
        }
      ],
      "RingTime": 5,
      "TalkRound": 0,
      "RedailCall": [
        {
          "CallID": "cb035452180xxxxxxxxb2c7db",
          "CallStartTime": "2024-03-11 10:19:27",
          "RingType": "normal",
          "RingTime": 2,
          "HangupType": "ByCallee",
          "ResultLabel": "F",
          "callee_number": "+86xxxxxxxx01",
          "caller_number": "+950xxxxxxxx88"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "Transfer",
        "PaymentTime": "Time_0"
      },
      "intention_description": "Needs Follow Up",
      "EventLabel": {
        "A0": "A0",
        "Correct_Person": "identity_correct_person",
        "Request_Installment": "action_item_request_installment"
      },
      "caller_number": "+95xxxxxxxx88",
      "CaseID": "7777777.0",
      "Variables": {
        "var1": "aaa",
        "var2": "bbb",
        "var3": "ccc"
      }
    }
  ]
}

示例代码

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": "16e0660e6cxxxxxxxxxxxxxxxx0abfe0e191",
  "workflow_name": "test_wf_call_webhook1",
  "nodetask_id": "4d308b4ed6xxxxxxxxed6a76e15d",
  "nodetask_name": "Voicebot Call1_f405f7",
  "TaskID": "490d5ec3c1xxxxxxxx2b759b5b",
  "TaskName": "wf_test_wf_call_webhook_Voicebot Call1_26bcf0",
  "Sign": "a395ce1acxxxxxxxx7bab53f5",
  "Details": [
    {
      "id": 2123875204,
      "RobotID": "4585",
      "CalleeName": "WILL SMITH",
      "CalleeGender": "",
      "CalleeNumber": "+86xxxxxxxx721",
      "CallStartTime": "2024-03-11T03:20:30Z",
      "CallEndTime": "2024-03-11T03:20:56Z",
      "Status": "finished",
      "Intention": "E",
      "CallID": "cad907xxxxxxxx35644a",
      "CallTimes": 2,
      "Comments": "7777777.0",
      "BorrowedDate": "2024-02-01",
      "DueDate": "2024-03-02",
      "BorrowedAmount": "20000.00",
      "TotalOwingAmount": "20310.00",
      "CurrencyUnit": "USD",
      "PlatformName": "AIRUDDER",
      "RingType": "normal",
      "HangupType": "ByRobot",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "halo (jeda 1-2 detik) selamat pagi",
          "text": ""
        },
        {
          "time": "00:00:03",
          "robottext": "Apa boleh minta waktunya sebentar?",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "Halo",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "mengapa tidak berbicara?",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "Halo? Apa suara saya terdengar?",
          "text": ""
        }
      ],
      "RingTime": 5,
      "TalkRound": 0,
      "RedailCall": [
        {
          "CallID": "cb035452180xxxxxxxxb2c7db",
          "CallStartTime": "2024-03-11 10:19:27",
          "RingType": "normal",
          "RingTime": 2,
          "HangupType": "ByCallee",
          "ResultLabel": "F",
          "callee_number": "+86xxxxxxxx01",
          "caller_number": "+950xxxxxxxx88"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "Transfer",
        "PaymentTime": "Time_0"
      },
      "intention_description": "Needs Follow Up",
      "EventLabel": {
        "A0": "A0",
        "Correct_Person": "identity_correct_person",
        "Request_Installment": "action_item_request_installment"
      },
      "caller_number": "+95xxxxxxxx88",
      "CaseID": "7777777.0",
      "Variables": {
        "var1": "aaa",
        "var2": "bbb",
        "var3": "ccc"
      }
    }
  ]
}'

Workflow外呼电话拨打结束通知 (催收/营销/电商示例)

请求参数

示例代码

返回响应