任务电话维度拨打结束状态通知

任务的电话拨打结束时(接通或者完成拨打次数)，不管接通还是未接通，主动通知对接方该任务的此电话拨打数据。其中接通的电话会在完成后立即通知；完成拨打次数但仍未接通的所有电话，会在任务结束后聚合通知。
如果此url 响应异常(http状态码非200)，我方会间隔1 分钟进行重试，最多5 次重试，失败后不再进行通知。请在收到数据后进行异步处理，尽快返回响应。
对接方需要提供两个参数给我方配置：
URL 回调地址
KEY 参数签名用的KEY, 或无，默认使用airudder签名

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

TaskID

string

必需

任务ID，成功添加任务后，您将获得TaskID，或者从“列出已创建的任务”API获取。

TaskName

string

必需

任务名称，创建任务时由对接方定义。

Sign

string

必需

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

PlanName

string

可选

当Task属于Plan创建时，会返回此字段。

Details

array [object {34}]

必需

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

integer

必需

名单ID，无需关注。

RobotID

string

必需

机器人的唯一 ID，该通电话由此机器人拨打。

CalleeName

string

必需

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

CalleeGender

enum<string>

必需

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

枚举值:

malefemale

CalleeNumber

string

必需

电话号码，与创建时上传的相同。

CallStartTime

string

必需

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

CallEndTime

string

必需

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

Status

enum<string>

通话状态

必需

枚举值:

createdpendingfinishedcancelledfailed

Intention

enum<string>

必需

由通话过程产生的意图，不同的机器人有不同的意图配置，请登录iCall网站查看机器人列表。

枚举值:

ABCDEFGHI……--

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>

响铃类型

必需

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnum notmatchnormalnull

HangupType

enum<string>

挂机类型

必需

枚举值:

ByCalleeByRobotCanceled

Slots

object

可选

该通电话命中的NER槽位和槽值（此字段将废弃，由NerSlots取代）

NerSlots

object

可选

该通电话命中的NER槽位和槽值（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

ExtraA

string

可选

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

ExtraB

string

可选

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

ExtraC

string

可选

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

AsrResult

array [object {3}]

可选

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

RingTime

integer

可选

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

TalkRound

integer

可选

该通电话机器人与用户的通话回合（此字段因国家/地区而异。如果您需要更多信息，请联系我们。）

RedailCall

array [object {8}]

可选

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

Multi_intention

object

可选

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

EventLabel

object

可选

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

call_notes

string

可选

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

caller_number

string

可选

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

示例

{
  "TaskID": "502380771007633e8d8b859ebf76970a",
  "TaskName": "Task-001",
  "Sign": "de9c60e6d7d623d75f1095e83b9bede3",
  "PlanName": "Plan_001",
  "Details": [
    {
      "id": 15744007,
      "RobotID": "4565",
      "CalleeName": "name1",
      "CalleeGender": "male",
      "CalleeNumber": "+6212345678",
      "CallStartTime": "2023-10-19T06:13:17Z",
      "CallEndTime": "2023-10-19T06:13:26Z",
      "Status": "finished",
      "Intention": "E",
      "intention_description": "xxxxx",
      "CallID": "6dbf57adc3ecf4f4bfd5efe85ccad659",
      "CallTimes": 2,
      "Comments": "C12345567",
      "BorrowedDate": "2022-05-03",
      "DueDate": "2022-05-11",
      "BorrowedAmount": "11.00",
      "TotalOwingAmount": "11.00",
      "CurrencyUnit": "INR",
      "PlatformName": "HAPPYPLANTE",
      "RingType": "normal",
      "HangupType": "ByCallee",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "Halo, ini Happy Planet, selamat datang di kedatangan Anda Apakah Anda perlu memeriksa pengiriman ekspres?>",
          "text": ""
        }
      ],
      "EventLabel": {
        "AskHelp_or_complain": "Hang_up_by_customer",
        "Uncertainty": "Hang_up_at_company_info",
        "final_label": "O"
      },
      "RingTime": 3,
      "TalkRound": 0,
      "RedailCall": [
        {
          "CallID": "138582ba03c98aeb04f2318cfa38c823",
          "CallStartTime": "2023-10-19 14:13:07",
          "RingType": "",
          "RingTime": 3,
          "HangupType": "ByCallee",
          "ResultLabel": "F",
          "caller_number": "+8613661834220",
          "callee_number": "+6212345678"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "ATM",
        "PaymentTime": "Time_0"
      },
      "call_notes": "",
      "caller_number": "+8613661834220"
    }
  ]
}

示例代码

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 '{
    "TaskID": "502380771007633e8d8b859ebf76970a",
    "TaskName": "Task-001",
    "Sign": "de9c60e6d7d623d75f1095e83b9bede3",
    "PlanName":"Plan_001",
    "Details": [
        {
            "id": 15744007,
            "RobotID": "4565",
            "CalleeName": "name1",
            "CalleeGender": "male",
            "CalleeNumber": "+6212345678",
            "CallStartTime": "2023-10-19T06:13:17Z",
            "CallEndTime": "2023-10-19T06:13:26Z",
            "Status": "finished",
            "Intention": "E",
            "intention_description": "xxxxx",
            "CallID": "6dbf57adc3ecf4f4bfd5efe85ccad659",
            "CallTimes": 2,
            "Comments": "C12345567",
            "BorrowedDate": "2022-05-03",
            "DueDate": "2022-05-11",
            "BorrowedAmount": "11.00",
            "TotalOwingAmount": "11.00",
            "CurrencyUnit": "INR",
            "PlatformName": "HAPPYPLANTE",
            "RingType": "normal",
            "HangupType": "ByCallee",
            "ExtraA": "",
            "ExtraB": "",
            "ExtraC": "",
            "AsrResult": [
                {
                    "time": "00:00:00",
                    "robottext": "Halo, ini Happy Planet, selamat datang di kedatangan Anda Apakah Anda perlu memeriksa pengiriman ekspres?>",
                    "text": ""
                }
            ],
            "EventLabel": {
                "AskHelp_or_complain": "Hang_up_by_customer",
                "Uncertainty": "Hang_up_at_company_info",
                "final_label": "O"
            },
            "RingTime": 3,
            "TalkRound": 0,
            "RedailCall": [
                {
                    "CallID": "138582ba03c98aeb04f2318cfa38c823",
                    "CallStartTime": "2023-10-19 14:13:07",
                    "RingType": "",
                    "RingTime": 3,
                    "HangupType": "ByCallee",
                    "ResultLabel": "F",
                    "caller_number": "+8613661834220",
                    "callee_number": "+6212345678"
                }
            ],
             "NerSlots": {
                    "PaymentMethod": "ATM",
                    "PaymentTime": "Time_0"
                },
            "call_notes": "",
            "caller_number": "+8613661834220"
        }
    ]
}'