AIRUDDER API
  1. Workflow
AIRUDDER API
  • Introductions
  • Quick Start
  • Get the Authorization token
    • Token Authentication and Obtain
      POST
  • Error Codes
    • Error Codes
  • Workflow
    • Webhooks of the Info of Predictive Dialer System
      • Webhook of Predictive Dialer Task Status Changes
      • Webhook of Predictive Dialer Contacts Status Changes
      • Webhook of Predictive Dialer Agents Status Changes
    • Create a New WorkFlow Task
      POST
    • Obtain the List of Workflow Templates
      GET
    • Add lists to an workflow task
      POST
    • Update the List Info of Workflow Task
      POST
    • Cancel the processes for a specific list
      POST
    • Notification of Call Completion in Workflow (Debt Collection/Marketing/E-commerce)
      POST
    • Notification of Call Completion in Workflow(Info Check)
      POST
    • Custom API Node Data Push
      POST
    • Verify the Custom API Node Data Push
      POST
    • Stop the Workflow Task
      POST
    • Obtain the Workflow Task List
      GET
    • Obtain the Subtask List of the Workflow
      GET
    • Obtain the Outbound Task List of Workflow
      POST
    • Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)
      POST
    • Obtain the Outbound Task Details of Workflow(Info Check)
      POST
    • Obtain Call Information and Recording Links by callee/caseid and taskid/workflow_id
      GET
    • Obtian Call Information and Recording Link by Call ID
      GET
    • Obtain All the Recordings of a Single Number in the Workflow
      GET
    • Query workflow_id using case_id/callee
      POST
    • Notification for Workflow List Completion
      POST
    • Notification of Workflow Status Change
      POST
    • Obtain the WABA Tasks List of Workflow
      GET
    • Obtain the WABA Task Details of Workflow
      GET
    • Notification of WABA Message Status Alteration in Workflow
      POST
    • Chatbot Session End Notification in Workflow
      POST
  1. Workflow

Verify the Custom API Node Data Push

Production
https://api.airudder.com
Production
https://api.airudder.com
POST
/service/cloud/workflow/apinoticeinfo
Verify and check if some of the data pushed by the custom API is correct. It can also be used to check history data within last three months. (Only the data pushed by the Custom API can be verified. It is not for the verification of end status notification of call tasks.)

Request

Header Params
Authorization
string 
required
Default:
Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU
Content-Type
string 
required
Default:
application/json
User-Agent
string 
optional
Default:
Airudder
Body Params application/json
workflow_id
string 
required
Workflow ID can be obtained from the data pushed by the Custom API Data Push.
node_id
string 
required
Workflow API Node ID, the unique identifier of the node, which can be obtained from data pushed by the Custom API Data Push.
callee
string 
required
The phone numbers of the list, which can be obtained from the data pushed by the Custom API Data Push.
case_id
string 
optional
Case ID, which can be obtained from the data pushed by the Custom API Data Push.
Example
{
    "workflow_id": "0ca6e3a59cf74630906683882aa5111",
    "callee": "+8610086",
    "node_id": "1d78b96d74c24737b186da7bcb23a2f8",
    "case_id": "caseid"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.airudder.com/service/cloud/workflow/apinoticeinfo' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "0ca6e3a59cf74630906683882aa5111",
    "callee": "+8610086",
    "node_id": "1d78b96d74c24737b186da7bcb23a2f8",
    "case_id": "caseid"
}'

Responses

🟢200Success
application/json
Body
data
object 
required
All fields are consistent with the meanings of the fields pushed in the custom API node data.
workflow_id
string 
required
workflow_name
string 
required
node_id
string 
required
node_name
string 
required
callee
object 
required
custom_attribute
object 
required
call
object 
required
status
string 
required
code
integer 
required
Example
{
    "data": {
        "workflow_id": "b761cdd784294xxxxxx869f85c",
        "workflow_name": "test_api_action4",
        "node_id": "6ade9e4443xxxxxx43a54b58",
        "node_name": "API1",
        "callee": {
            "case_id": "123456.0",
            "callee_name": "WILL SMITH",
            "callee_gender": "",
            "callee_number": "+861xxxxxx721",
            "platform_name": "AIRUDDER",
            "extra_a": "",
            "extra_b": "",
            "extra_c": "",
            "extra": [
                {
                    "Content": "+861xxxxxx795,+861xxxxxx721",
                    "Question": "extend_callees"
                }
            ],
            "extend": {
                "variables": {},
                "detail_source": "web",
                "pds_variables": {}
            },
            "comments": "123456.0",
            "borrowed_date": "2024-02-01",
            "due_date": "2024-03-07",
            "borrowed_amount": "20000.00",
            "total_owing_amount": "20310.00",
            "currency_unit": "USD"
        },
        "custom_attribute": {
            "a": "1",
            "b": "2"
        },
        "call": {
            "task_id": "459acf3df0ecxxxxxx9679dc208ad96",
            "call_id": "cd878f6611adxxxxxx1a5a3ec5525b",
            "callee_number": "+8618717905721",
            "robot_id": "4585",
            "call_start_time": "2024-03-12 14:54:26",
            "call_end_time": "2024-03-12 14:54:52",
            "call_times": 4,
            "ring_type": "normal",
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "ss02",
                    "answer_text": "s s cero dos",
                    "status": "Completed",
                    "answer_text_slot": "s02;02",
                    "var": "S02",
                    "verification_results": "Match",
                    "question_content": "CURP Verification",
                    "question_type": "open",
                    "whether_answer": "Answered"
                }
            ],
            "hangup_type": "ByRobot",
            "intention": "E",
            "slots": "",
            "ner_slots": {
                "PaymentMethod": "Transfer",
                "PaymentTime": "Time_0"
            },
            "redial_call": [
                {
                    "call_id": "ef1a7953b0cxxxxxxab653217cd24",
                    "call_start_time": "2024-03-12 14:51:15",
                    "ring_type": "normal",
                    "ring_time": 0,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+861xxxxxx795",
                    "caller_number": "+950xxxxxx0088"
                },
                {
                    "call_id": "df831fc0491xxxxxx7f1114605f9de",
                    "call_start_time": "2024-03-12 14:51:24",
                    "ring_type": "normal",
                    "ring_time": 7,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+8618xxxxxx721",
                    "caller_number": "+950xxxxxx088"
                },
                {
                    "call_id": "f27a2d3c1dxxxxxx693ed0cfe93d77aa",
                    "call_start_time": "2024-03-12 14:52:23",
                    "ring_type": "normal",
                    "ring_time": 0,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+861xxxxxx1795",
                    "caller_number": "+950xxxxxx088"
                }
            ],
            "talk_round": 0,
            "ring_time": 2,
            "multi_label": {
                "A0": "A0",
                "Correct_Person": "identity_correct_person",
                "Request_Installment": "action_item_request_installment"
            },
            "intention_description": "Needs Follow Up",
            "asr_ptp": "",
            "asr_result": [
                {
                    "time": "00:00:00",
                    "robottext": "halo (jeda 1-2 detik) selamat siang",
                    "text": ""
                },
                {
                    "time": "00:00:03",
                    "robottext": "Apa boleh minta waktunya sebentar?",
                    "text": ""
                },
                {
                    "time": "00:00:10",
                    "robottext": "",
                    "text": ""
                },
                {
                    "time": "00:00:10",
                    "robottext": "Halo",
                    "text": ""
                },
                {
                    "time": "00:00:13",
                    "robottext": "",
                    "text": ""
                },
                {
                    "time": "00:00:13",
                    "robottext": "mengapa tidak berbicara?",
                    "text": ""
                },
                {
                    "time": "00:00:18",
                    "robottext": "",
                    "text": ""
                },
                {
                    "time": "00:00:18",
                    "robottext": "Halo? Apa suara saya terdengar?",
                    "text": ""
                }
            ],
            "caller_number": "+95xxxxxx0088"
        }
    },
    "status": "OK",
    "code": 200
}
🟢200Exception
Modified at 2025-03-27 06:22:37
Previous
Custom API Node Data Push
Next
Stop the Workflow Task
Built with