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 参数

Body 参数application/json

示例

{
    "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"
        }
    ]
}'

请求参数

请求示例代码

返回响应