Webhook of Call

When a phone call for a task is completed (whether connected or not), proactively notify the counterpart with the call data for that task. For connected calls, the notification will be sent immediately after completion. For calls that have reached the maximum number of attempts but remain unanswered, the notifications will be aggregated and sent after the task is finished.

If there is an exception in the response from the provided URL (HTTP status code other than 200), we will retry at an interval of 1 minute, up to a maximum of 5 retries. After that, no further notifications will be attempted. Please handle the received data asynchronously and return a response as soon as possible.

The counterpart needs to provide two parameters for configuration:

URL: Callback address
KEY: KEY used for parameter signing, or none (default signing will be done using "airudder" signature).

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

TaskID

string

必需

TaskName

string

必需

The name of the task

Sign

string

必需

md5 sign value. You can verify the sign and process on the task ID. It is not required to do verification.
Sign Rule：

TaskID+KEY by utf-8 code
Use hexadecimal md5 to encrypt the value in step one
Lowercase. Case-sensitive.
For example
TaskID=ac23fa05005e59b92e0b8a19fa5faf07 KEY=airudder
Expression = md5(TaskID+KEY).hexdigest()
md5 value=4d6017151d678e816c678d90e56e6e28

PlanName

string

可选

If the task is created by the plan, then this will be returned. (This field varies when the country varies. If you need more info, please contact us)

Details

array [object {29}]

必需

integer

必需

Call Detail ID. No need to pay attention to.

RobotID

string

必需

The unique ID for Robot. Please contact us to get your RobotID.

CalleeName

string

必需

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

CalleeGender

string

必需

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

CalleeNumber

string

必需

CallStartTime

string

必需

CallEndTime

string

必需

Status

enum<string>

必需

Call Status

枚举值:

createdpendingfinishedcancelledfailed

Intention

enum<string>

必需

The intention label varies with each robot. Please log into the iCall website - Robot List to check it.

枚举值:

ABCDEFGHI……--

intention_description

string

可选

Intention description, different intention descriptions of different robots are different. (This field varies by country. If you need more information, please contact us. )

CallID

string

必需

The unique ID for each call.

CallTimes

integer

必需

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

Comments

string

必需

Robot variables, the same as the one uploaded when creating it.

PlatformName

string

必需

Robot variables, the same as the one uploaded when creating it.

RingType

enum<string>

必需

Ringing Type

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

HangupType

enum<string>

必需

Hangup Type

枚举值:

ByCalleeByRobotCanceled

ExtraA

string

必需

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

ExtraB

string

必需

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

ExtraC

string

必需

Custom Variable. The detailed names and contents vary with robots. Please contact us in advance to confirm.

Slots

object

可选

The slots info of this call. (This field will be deprecated and replaced by NerSlots)

NerSlots

object

可选

The slots info of this call. (This field varies when the country varies. If you need more info, please contact us.)

AsrResult

array [object {3}]

可选

The slots info of this call. (This field varies when the country varies. If you need more info, please contact us.)

RingTime

string

可选

Ringing duration of the call. (This field varies when the country varies. If you need more info, please contact us.)

TalkRound

string

可选

Talk Rounds of the call. (This field varies when the country varies. If you need more info, please contact us.)

RedailCall

array [object {8}]

可选

Detailed info of redials of the call. (This field varies when the country varies. If you need more info, please contact us.)

Multi_intention

object

可选

The multi-intention of the call. (This field will be deprecated and replaced by EventLabel)

EventLable

object

可选

The eventlable of the call. (This field varies when the country varies. If you need more info, please contact us.)

call_notes

string

可选

Notes for this call(This field varies when the country varies. If you need more info, please contact us.)

caller_number

string

可选

The calling number for this call.(This field varies when the country varies. If you need more info, please contact us.)

示例

{
    "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",
            "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": ""
                }
            ],
            "EventLable": {
                "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 'Please provide your URL for Webhook to us.' \
--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",
            "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": ""
                }
            ],
            "EventLable": {
                "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"
        }
    ]
}'

请求参数

示例代码

返回响应