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

Body 参数application/json

示例

{
    "TaskID": "taskid38a0b923820dcc509a6f75849b",
    "TaskName": "taskname20240601",
    "Sign": "sign4238a0b923820dcc509a6f75849b",
    "Details": [
        {
            "id": 1,
            "RobotID": "1234",
            "CalleeName": "CalleeName",
            "CalleeGender": "male",
            "CalleeNumber": "+6212345678",
            "CallStartTime": "2024-06-01T10:11:12Z",
            "CallEndTime": "2024-06-01T10:11:12Z",
            "CallDialTime": "2024-06-01T10:11:12Z",
            "CallConnectTime": "2024-06-01T10:11:12Z",
            "RobotEndTime": "2024-06-01T10:11:12Z",
            "Status": "finished",
            "Intention": "F",
            "CallID": "callid38a0b923820dcc509a6f75849b",
            "CallTimes": 5,
            "Comments": "",
            "BorrowedDate": "2024-10-12",
            "DueDate": "2024-12-11",
            "BorrowedAmount": "1.00",
            "TotalOwingAmount": "2.00",
            "CurrencyUnit": "unit",
            "PlatformName": "AIRUDDER",
            "RingType": "normal",
            "HangupType": "ByCallee",
            "HangupBy": "ByCallee",
            "ExtraA": "extra_a",
            "ExtraB": "extra_b",
            "ExtraC": "extra_c",
            "RobotMethod": "single",
            "AsrResult": [
                {
                    "time": "00:00:00",
                    "robottext": "Hello, i am robot",
                    "text": "hello robot"
                }
            ],
            "Multi_intention": "{}",
            "Slots": "slots",
            "NerSlots": {
                "payment_method": "AutoDebet"
            },
            "intention_description": "intention description",
            "EventLabel": {
                "ConclusionReceive": "A1"
            },
            "caller_number": "+85111111",
            "RedailCall": [
                {
                    "CallID": "callid38a0b923820dcc509a6f75849b",
                    "CallStartTime": "2024-06-10 12:13:14",
                    "RingType": "outofarea",
                    "RingTime": 5,
                    "HangupType": "ByRobot",
                    "ResultLabel": "F",
                    "callee_number": "+6212345678",
                    "caller_number": "+85111111",
                    "reason_code": "Null"
                }
            ],
            "TalkRound": 1,
            "RingTime": 5,
            "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 --request POST 'Please provide your URL for Webhook to us.' \
--header 'User-Agent: AIRUDDER' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TaskID": "taskid38a0b923820dcc509a6f75849b",
    "TaskName": "taskname20240601",
    "Sign": "sign4238a0b923820dcc509a6f75849b",
    "Details": [
        {
            "id": 1,
            "RobotID": "1234",
            "CalleeName": "CalleeName",
            "CalleeGender": "male",
            "CalleeNumber": "+6212345678",
            "CallStartTime": "2024-06-01T10:11:12Z",
            "CallEndTime": "2024-06-01T10:11:12Z",
            "CallDialTime": "2024-06-01T10:11:12Z",
            "CallConnectTime": "2024-06-01T10:11:12Z",
            "RobotEndTime": "2024-06-01T10:11:12Z",
            "Status": "finished",
            "Intention": "F",
            "CallID": "callid38a0b923820dcc509a6f75849b",
            "CallTimes": 5,
            "Comments": "",
            "BorrowedDate": "2024-10-12",
            "DueDate": "2024-12-11",
            "BorrowedAmount": "1.00",
            "TotalOwingAmount": "2.00",
            "CurrencyUnit": "unit",
            "PlatformName": "AIRUDDER",
            "RingType": "normal",
            "HangupType": "ByCallee",
            "HangupBy": "ByCallee",
            "ExtraA": "extra_a",
            "ExtraB": "extra_b",
            "ExtraC": "extra_c",
            "RobotMethod": "single",
            "AsrResult": [
                {
                    "time": "00:00:00",
                    "robottext": "Hello, i am robot",
                    "text": "hello robot"
                }
            ],
            "Multi_intention": "{}",
            "Slots": "slots",
            "NerSlots": {
                "payment_method": "AutoDebet"
            },
            "intention_description": "intention description",
            "EventLabel": {
                "ConclusionReceive": "A1"
            },
            "caller_number": "+85111111",
            "RedailCall": [
                {
                    "CallID": "callid38a0b923820dcc509a6f75849b",
                    "CallStartTime": "2024-06-10 12:13:14",
                    "RingType": "outofarea",
                    "RingTime": 5,
                    "HangupType": "ByRobot",
                    "ResultLabel": "F",
                    "callee_number": "+6212345678",
                    "caller_number": "+85111111",
                    "reason_code": "Null"
                }
            ],
            "TalkRound": 1,
            "RingTime": 5,
            "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"
        }
    ]
}'

请求参数

请求示例代码

返回响应