Webhook of Call

When a call within a task ends (whether answered or the maximum dial attempts are reached), the system will proactively send the call data to the counterpart after all redial attempts are completed, regardless of whether the call was connected or not.

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

Body 参数application/json

示例

{
    "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",
                    "reason_code": "Null"
                }
            ],
            "NerSlots": {
                "PaymentMethod": "ATM",
                "PaymentTime": "Time_0"
            },
            "call_notes": "",
            "caller_number": "+8613661834220",
            "CallDialTime": "2023-10-19T06:13:07Z",
            "CallConnectTime": "2023-10-19T06:13:17Z",
            "RobotEndTime": "2023-10-19T06:13:26Z",
            "HangupBy": "ByCallee",
            "RobotMethod": "single",
            "HumanRobotSummary": "xxxxxxxxxxxxxxxxxxxxxxxxx",
            "Emotion": "xxxxxxxxxxxx",
            "RecordingLink": "https://api.airudder.com/b53c405fd1a2*******c6b_3263a688977108becdccf010aacec2b3.mp3",
            "Transfer": {
                "TransferStatus": 2,
                "TransferFailureReason": "",
                "TransferTime": "2024-02-02T01:48:51Z",
                "TransferRingTime": "2024-02-02T01:48:52Z",
                "TransferSuccessTime": "2024-02-02T01:48:52Z",
                "TransferReason": "",
                "TransferCallId": "artificial_fd964********be3252519"
            },
            "reason_code": "Null"
        }
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.airudder.com/Please provide your URL for Webhook to us.' \
--header 'User-Agent: AIRUDDER' \
--header 'User-Agent: AIRUDDER' \
--header 'Authorization: Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU' \
--header 'Content-Type: application/json' \
--data '{
    "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",
                    "reason_code": "Null"
                }
            ],
            "NerSlots": {
                "PaymentMethod": "ATM",
                "PaymentTime": "Time_0"
            },
            "call_notes": "",
            "caller_number": "+8613661834220",
            "CallDialTime": "2023-10-19T06:13:07Z",
            "CallConnectTime": "2023-10-19T06:13:17Z",
            "RobotEndTime": "2023-10-19T06:13:26Z",
            "HangupBy": "ByCallee",
            "RobotMethod": "single",
            "HumanRobotSummary": "xxxxxxxxxxxxxxxxxxxxxxxxx",
            "Emotion": "xxxxxxxxxxxx",
            "RecordingLink": "https://api.airudder.com/b53c405fd1a2*******c6b_3263a688977108becdccf010aacec2b3.mp3",
            "Transfer": {
                "TransferStatus": 2,
                "TransferFailureReason": "",
                "TransferTime": "2024-02-02T01:48:51Z",
                "TransferRingTime": "2024-02-02T01:48:52Z",
                "TransferSuccessTime": "2024-02-02T01:48:52Z",
                "TransferReason": "",
                "TransferCallId": "artificial_fd964********be3252519"
            },
            "reason_code": "Null"
        }
    ]
}'

请求参数

请求示例代码

返回响应