AIRUDDER API

Custom API Node Data Push

Production

POST

The integrating party provides this url to configure in the workflow.

After the phone call is completed, initiate a notification through an API node.The API node is configured in the web-based workflow template, supporting the customization of notification data to meet customers' personalized requirements for data feedback, retrieval, and processing. The push scope includes outbound tasks performed by the voicebot (including Voicebot Call Action and strategy components).

If the provided URL encounters an exception, our system will retry at 1-minute intervals, for a maximum of 5 retries. After 5 failed attempts, no further notifications will be sent. Please respond within 10 seconds upon receiving the data and handle the data storage and subsequent logic asynchronously.

Request

Header Params

Content-Type

string

required

Default:

application/json

User-Agent

string

optional

Default:

Airudder

Body Params application/json

workflow_id

string

required

Workflow uniquely id.

workflow_name

string

required

Workflow name.

node_id

string

required

The node_id of the API node that the list goes through within the workflow serves as a unique identifier for that node.

node_name

string

required

The name of the API node that the list goes through within the workflow.

callee

object

required

Attributes of the call list.

case_id

string

required

Customer unique identifier, consistent with the uploaded content.

callee_name

string

required

Customer name, consistent with the uploaded content, uploaded using the field name "customer_name."

callee_gender

string

required

Customer gender, consistent with the uploaded content, uploaded using the field name "gender."

callee_number

string

required

Customer phone number, consistent with the uploaded content, uploaded using the field name "callee."

platform_name

string

required

Platform, consistent with the uploaded content, uploaded using the field name "platform." Predefined custom variable fields, consistent with the uploaded content.

extra_a

string

required

Predefined custom variable fields, consistent with the uploaded content.

extra_b

string

required

Predefined custom variable fields, consistent with the uploaded content.

extra_c

string

required

Predefined custom variable fields, consistent with the uploaded content.

extra

array [object {2}]

required

Collection of non-predefined custom variables.

extend

object

required

Collection of list-related information.

comments

string

required

Remarks, consistent with the uploaded content.

borrowed_date

string

optional

This field is only available in the debt collection scenario.

due_date

string

optional

This field is only available in the debt collection scenario.

borrowed_amount

string

optional

This field is only available in the debt collection scenario.

total_owing_amount

string

optional

This field is only available in the debt collection scenario.

currency_unit

string

optional

This field is only available in the debt collection scenario.

custom_attribute

object

required

Custom data set in the API node.

var1

string

required

var2

string

required

call

object

required

The data associated with outbound calls for the list.

task_id

string

required

Outbound task ID to which the call belongs.

call_id

string

required

Unique identifier of the call.

robot_id

string

required

Robot ID responsible for executing the call.

callee_number

string

required

Called number (in the case of multiple numbers in a list, this represents the last dialed number).

call_start_time

string

required

Timezone in the customer's local time. For connected calls, this field indicates the time when the user answered the call, excluding ringing time. For unanswered calls, this field is the same as CallEndTime.

call_end_time

string

required

End the call time, in account's time zone.

call_times

integer

required

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

ring_type

enum<string>

required

Ring Category, initial value is null.

Allowed values:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

hangup_type

enum<string>

required

Hangup Category, initial value is ByRobot.

Allowed values:

ByCalleeByRobotCanceled

intention

string

required

Intent Labels, different robots have different intent labels.

multi_label

object

required

Event labels hit during the call.

asr_ptp

string

required

asr_result

array [object {3}]

required

slots

string

required

Please ignore this field.

ner_slots

object

required

Slot key and value information for the call. (This field varies by country/region. If you need more information, please contact us.)

talk_round

integer

required

Conversation rounds. (This field varies by country/region. If you need more information, please contact us.)

ring_time

integer

required

Ring duration of the call. (This field varies by country/region. If you need more information, please contact us.)

intention_description

string

required

Intent description, different robots have different intent descriptions. (This field varies by country/region. If you need more information, please contact us.)

redial_call

array [object {8}]

optional

Specific information on redialing within the rounds for the call. (This field varies by country, please contact us if needed.)

caller_number

string

optional

Caller's phone number for the call. (This field varies by country/region. If you need more information, please contact us.)

question_answer

array [object {10}]

optional

Example

{
  "workflow_id": "079918b288xxxxxxxx3815e2a8030eb",
  "workflow_name": "test_api_action6",
  "node_id": "f878645926xxxxxxxxb0b779ba254",
  "node_name": "API2",
  "callee": {
    "case_id": "12345.0",
    "callee_name": "WILL SMITH",
    "callee_gender": "MALE",
    "callee_number": "+861xxxxxxxx5721",
    "platform_name": "AIZCC",
    "extra_a": "a",
    "extra_b": "b",
    "extra_c": "c",
    "extra": [
      {
        "Content": "d",
        "Question": "extra_d"
      }
    ],
    "extend": {
      "variables": {
        "extra_d": "d"
      },
      "detail_source": "web",
      "pds_variables": {}
    },
    "comments": "12345.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": "b1a9e2ea8xxxxxxxx1551b6454b414b",
    "call_id": "817377d194xxxxxxxxc8ad463bc81d996a",
    "callee_number": "+86xxxxxx5721",
    "robot_id": "4496",
    "call_start_time": "2024-03-11 15:58:26",
    "call_end_time": "2024-03-11 15:59:12",
    "call_times": 2,
    "ring_type": "normal",
    "hangup_type": "ByCallee",
    "intention": "E",
    "slots": "",
    "ner_slots": {
      "PaymentMethod": "Transfer",
      "PaymentTime": "Time_0"
    },
    "talk_round": 1,
    "ring_time": 2,
    "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"
      }
    ],
    "multi_label": {
      "A0": "A0",
      "Correct_Person": "identity_correct_person",
      "Request_Installment": "action_item_request_installment"
    },
    "intention_description": "No Voice",
    "asr_ptp": "",
    "asr_result": [
      {
        "time": "00:00:00",
        "robottext": "This is Hannah, I'm a customer service agent. We called you today to confirm your order with us so we could deliver it to you. Can I take a moment of your time here?",
        "text": "no no no no no"
      },
      {
        "time": "00:00:14",
        "robottext": "",
        "text": ""
      },
      {
        "time": "00:00:14",
        "robottext": "You have placed an order via our website. Are the above-mentioned information correct?",
        "text": ""
      },
      {
        "time": "00:00:25",
        "robottext": "Hello?",
        "text": ""
      },
      {
        "time": "00:00:25",
        "robottext": "You have placed an  order via our website. Can you confirm the information ?",
        "text": ""
      },
      {
        "time": "00:00:35",
        "robottext": "Are you there?",
        "text": ""
      },
      {
        "time": "00:00:35",
        "robottext": "You have placed an  order via our website. Can you confirm the information ?",
        "text": ""
      },
      {
        "time": "00:00:45",
        "robottext": "Sorry,we cannot hear your clearly. we will try to contact you later.Thank you for your time. Goodbye!",
        "text": ""
      }
    ],
    "redial_call": [
      {
        "call_id": "4edf1697f7bxxxxxxxx65bca97f996bb",
        "call_start_time": "2024-03-05 16:15:53",
        "ring_type": "normal",
        "ring_time": 0,
        "hangup_type": "ByCallee",
        "result_label": "F",
        "callee_number": "+822xxxxxxxx2795",
        "caller_number": "+950xxxxxxxx088"
      },
      {
        "call_id": "001453803xxxxxxxxcc53b4a3b9db",
        "call_start_time": "2024-03-05 16:15:56",
        "ring_type": "normal",
        "ring_time": 15,
        "hangup_type": "ByCallee",
        "result_label": "F",
        "callee_number": "+83xxxxxxxx795",
        "caller_number": "+95xxxxxxxx0088"
      },
      {
        "call_id": "04b6d8d97xxxxxxxx6b16db252a1dad8",
        "call_start_time": "2024-03-05 16:16:59",
        "ring_type": "normal",
        "ring_time": 0,
        "hangup_type": "ByCallee",
        "result_label": "F",
        "callee_number": "+822xxxxxxxx795",
        "caller_number": "+95xxxxxxxx0088"
      }
    ],
    "caller_number": "+95xxxxxxxx0088"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'The integrating party provides this url to configure in the workflow.' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "079918b288xxxxxxxx3815e2a8030eb",
    "workflow_name": "test_api_action6",
    "node_id": "f878645926xxxxxxxxb0b779ba254",
    "node_name": "API2",
    "callee": {
        "case_id": "12345.0",
        "callee_name": "WILL SMITH",
        "callee_gender": "MALE",
        "callee_number": "+861xxxxxxxx5721",
        "platform_name": "AIZCC",
        "extra_a": "a",
        "extra_b": "b",
        "extra_c": "c",
        "extra": [
            {
                "Content": "d",
                "Question": "extra_d"
            }
        ],
        "extend": {
            "variables": {
                "extra_d": "d"
            },
            "detail_source": "web",
            "pds_variables": {}
        },
        "comments": "12345.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": "b1a9e2ea8xxxxxxxx1551b6454b414b",
        "call_id": "817377d194xxxxxxxxc8ad463bc81d996a",
        "callee_number": "+86xxxxxx5721",
        "robot_id": "4496",
        "call_start_time": "2024-03-11 15:58:26",
        "call_end_time": "2024-03-11 15:59:12",
        "call_times": 2,
        "ring_type": "normal",
        "hangup_type": "ByCallee",
        "intention": "E",
        "slots": "",
        "ner_slots": {
            "PaymentMethod": "Transfer",
            "PaymentTime": "Time_0"
        },
        "talk_round": 1,
        "ring_time": 2,
        "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"
            }
        ],
        "multi_label": {
            "A0": "A0",
            "Correct_Person": "identity_correct_person",
            "Request_Installment": "action_item_request_installment"
        },
        "intention_description": "No Voice",
        "asr_ptp": "",
        "asr_result": [
            {
                "time": "00:00:00",
                "robottext": "This is Hannah, I'\''m a customer service agent. We called you today to confirm your order with us so we could deliver it to you. Can I take a moment of your time here?",
                "text": "no no no no no"
            },
            {
                "time": "00:00:14",
                "robottext": "",
                "text": ""
            },
            {
                "time": "00:00:14",
                "robottext": "You have placed an order via our website. Are the above-mentioned information correct?",
                "text": ""
            },
            {
                "time": "00:00:25",
                "robottext": "Hello?",
                "text": ""
            },
            {
                "time": "00:00:25",
                "robottext": "You have placed an  order via our website. Can you confirm the information ?",
                "text": ""
            },
            {
                "time": "00:00:35",
                "robottext": "Are you there?",
                "text": ""
            },
            {
                "time": "00:00:35",
                "robottext": "You have placed an  order via our website. Can you confirm the information ?",
                "text": ""
            },
            {
                "time": "00:00:45",
                "robottext": "Sorry,we cannot hear your clearly. we will try to contact you later.Thank you for your time. Goodbye!",
                "text": ""
            }
        ],
        "redial_call": [
            {
                "call_id": "4edf1697f7bxxxxxxxx65bca97f996bb",
                "call_start_time": "2024-03-05 16:15:53",
                "ring_type": "normal",
                "ring_time": 0,
                "hangup_type": "ByCallee",
                "result_label": "F",
                "callee_number": "+822xxxxxxxx2795",
                "caller_number": "+950xxxxxxxx088"
            },
            {
                "call_id": "001453803xxxxxxxxcc53b4a3b9db",
                "call_start_time": "2024-03-05 16:15:56",
                "ring_type": "normal",
                "ring_time": 15,
                "hangup_type": "ByCallee",
                "result_label": "F",
                "callee_number": "+83xxxxxxxx795",
                "caller_number": "+95xxxxxxxx0088"
            },
            {
                "call_id": "04b6d8d97xxxxxxxx6b16db252a1dad8",
                "call_start_time": "2024-03-05 16:16:59",
                "ring_type": "normal",
                "ring_time": 0,
                "hangup_type": "ByCallee",
                "result_label": "F",
                "callee_number": "+822xxxxxxxx795",
                "caller_number": "+95xxxxxxxx0088"
            }
        ],
        "caller_number": "+95xxxxxxxx0088"
    }
}'

Responses

🟢200success

application/json

Body

object {0}

Example

{}

Modified at 2025-03-27 06:24:37

Notification of Call Completion in Workflow(Info Check)

Verify the Custom API Node Data Push