Webhook of Call

When the call is finished (either connected or completed), regardless of whether it is connected or not, the counterparty will be notified of the call data for the task. If this url responds abnormally, we will retry at intervals of 1 minute and will make no notifications after a maximum of 5 failed retries.
The counterparty needs to provide one parameter for us to configure this feature.
There are one parameter needed for configuration
URL The URL for Webhook

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

task_name

string

必需

The name of the task.

task_id

string

必需

TaskID could be retrieved after successfully adding a task.

status

enum<string>

必需

枚举值:

createdpendingfinishedcallingcanceledpaused

created_at

string

必需

repeat_interval

integer

必需

repeat_number

integer

必需

robot_hash

string

必需

Robot ID of the call.

robot_method

string

必需

sip_line

string

必需

schedule_start_time

string

必需

schedule_end_time

string

必需

details

array [object {23}]

必需

integer

必需

The id of the call. No need to pay attention to.

callee

string

必需

result

string

必需

result_label

string

必需

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. )

duration

integer

必需

hangup_type

enum<string>

必需

枚举值:

ByCalleeByRobotCanceled

ring_type

enum<string>

必需

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

question_answer

array [object {10}]

必需

Multi_intention

object

可选

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

EventLabel

object

可选

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

variables

object

可选

Variable information uploaded by users.(This field varies when the country varies. If you need more info, please contact us.)

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.)

robot_hash

string

必需

call_id

string

必需

The unique id for the call.

call_times

integer

必需

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

call_start_time

string

必需

Call start time

call_end_time

string

必需

Call end time

ring_time

integer

可选

The ringing time

talk_round

integer

可选

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

redail_call

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.)

caller_number

string

可选

示例

{
    "task_id": "ic1a7a8f2bxxxxxxxxxxec25a9b2",
    "task_name": "xxxxxxxxxxc25a9b2_$[6567]",
    "status": "finished",
    "created_at": "2022-12-19 15:14:52",
    "repeat_interval": 0,
    "repeat_number": 0,
    "robot_hash": "f3298554xxxxxxx88aa595674",
    "robot_method": "single",
    "sip_line": "LINE",
    "schedule_start_time": "2022-12-19 15:14:52",
    "schedule_end_time": "2022-12-19 15:24:52",
    "details": [
        {
            "id": 931888898,
            "callee": "+888888888",
            "result": "failed",
            "result_label": "F",
            "intention_description": "xxxxx",
            "duration": 0,
            "hangup_type": "ByCallee",
            "ring_type": "busy",
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "",
                    "answer_text": "",
                    "status": "Created",
                    "answer_text_slot": "",
                    "var": "",
                    "verification_results": "",
                    "question_content": "",
                    "question_type": "",
                    "whether_answer": ""
                },
                {
                    "question_name": "Q2",
                    "answer": "",
                    "answer_text": "",
                    "status": "Created",
                    "answer_text_slot": "",
                    "var": "",
                    "verification_results": "",
                    "question_content": "",
                    "question_type": "",
                    "whether_answer": ""
                },
                {
                    "question_name": "Q3",
                    "answer": "",
                    "answer_text": "",
                    "status": "Created",
                    "answer_text_slot": "",
                    "var": "",
                    "verification_results": "",
                    "question_content": "",
                    "question_type": "",
                    "whether_answer": ""
                }
            ],
            "EventLabel": {
                "VerifyPass": "VerifyPass"
            },
            "NerSlots": {
                "PaymentMethod": "ATM",
                "PaymentTime": "Time_0"
            },
            "variables": {
                "creditnumber": "1234",
                "var2": "03",
                "birthday": "1225"
            },
            "robot_hash": "f3298554be9xxxxxxxxaa595674",
            "call_id": "ic9adfe00d474bxxxxxxxx5351bc0",
            "call_times": 1,
            "call_start_time": "2022-12-19 15:17:14",
            "call_end_time": "2022-12-19 15:17:14",
            "ring_time": 0,
            "talk_round": 0,
            "redail_call": [
                {
                    "call_id": "icbe5690fbcbd87a2fb35ea099a966bc",
                    "call_start_time": "2024-02-01 16:15:57",
                    "ring_type": "notmatch",
                    "ring_time": 0,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+8618116214781",
                    "caller_number": "+9501359900088"
                }
            ],
            "caller_number": "+6777383883"
        }
    ]
}

示例代码

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 '{
    "task_id": "ic1a7a8f2bxxxxxxxxxxec25a9b2",
    "task_name": "xxxxxxxxxxc25a9b2_$[6567]",
    "status": "finished",
    "created_at": "2022-12-19 15:14:52",
    "repeat_interval": 0,
    "repeat_number": 0,
    "robot_hash": "f3298554xxxxxxx88aa595674",
    "robot_method": "single",
    "sip_line": "LINE",
    "schedule_start_time": "2022-12-19 15:14:52",
    "schedule_end_time": "2022-12-19 15:24:52",
    "details": [
        {
            "id": 931888898,
            "callee": "+888888888",
            "result": "failed",
            "result_label": "F",
            "intention_description": "xxxxx",
            "duration": 0,
            "hangup_type": "ByCallee",
            "ring_type": "busy",
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "",
                    "answer_text": "",
                    "status": "Created",
                    "answer_text_slot": "",
                    "var": "",
                    "verification_results": "",
                    "question_content": "",
                    "question_type": "",
                    "whether_answer": ""
                },
                {
                    "question_name": "Q2",
                    "answer": "",
                    "answer_text": "",
                    "status": "Created",
                    "answer_text_slot": "",
                    "var": "",
                    "verification_results": "",
                    "question_content": "",
                    "question_type": "",
                    "whether_answer": ""
                },
                {
                    "question_name": "Q3",
                    "answer": "",
                    "answer_text": "",
                    "status": "Created",
                    "answer_text_slot": "",
                    "var": "",
                    "verification_results": "",
                    "question_content": "",
                    "question_type": "",
                    "whether_answer": ""
                }
            ],
            "EventLabel": {
                "VerifyPass": "VerifyPass"
            },
            "NerSlots": {
                "PaymentMethod": "ATM",
                "PaymentTime": "Time_0"
            },
            "variables": {
                "creditnumber": "1234",
                "var2": "03",
                "birthday": "1225"
            },
            "robot_hash": "f3298554be9xxxxxxxxaa595674",
            "call_id": "ic9adfe00d474bxxxxxxxx5351bc0",
            "call_times": 1,
            "call_start_time": "2022-12-19 15:17:14",
            "call_end_time": "2022-12-19 15:17:14",
            "ring_time": 0,
            "talk_round": 0,
            "redail_call": [
                {
                    "call_id": "icbe5690fbcbd87a2fb35ea099a966bc",
                    "call_start_time": "2024-02-01 16:15:57",
                    "ring_type": "notmatch",
                    "ring_time": 0,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+8618116214781",
                    "caller_number": "+9501359900088"
                }
            ],
            "caller_number": "+6777383883"
        }
    ]
}'

请求参数

示例代码

返回响应