Custom API Data Push

The custom data processing is available for workflow templates and the whole workflow module to satisfy the data needs of the customers, be it data callback, check or process. The one can be used to push the data of robot outbound task(including OB Call Action, Strategy Components). Additional data can be added to fit custom needs for the result data.
Please contact us to customize the data push configurations.

If the url responds abnormally(the status code of the http is not 200), we will retry after a minute interval, yet we won't try again after 5 failures.

One parameter is needed from the party to configure the API:
URL Callback Address

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_id

string

必需

Workflow ID

workflow_name

string

必需

Workflow Name

node_id

string

必需

Node ID , no need to pay attention to

node_name

string

必需

Node Name, no need to pay attention to

callee

object

必需

Phone Number attributes

case_id

string

必需

Phone Number Identifier。The unique number of the customer, the default is the same as callee.

callee_name

string

必需

Callee Name

callee_gender

string

必需

Callee Gender

callee_number

string

必需

Callee Phone Number

platform_name

string

必需

Platform Name

extra_a

string

必需

Extra Custom Variable

extra_b

string

必需

Extra Custom Variable

extra_c

string

必需

Extra Custom Variable

extra

array [object]

必需

Custom variables for bots.

extend

object

必需

Show custom parameters in workflow Customized Attributes component

comments

string

必需

borrowed_date

string

必需

Borrow Date (Only available for Collection)

due_date

string

必需

Due Date (Only available for Collection)

borrowed_amount

string

必需

Borrowed Amount (Only available for Collection)

total_owing_amount

string

必需

Total Amount Owing (Only available for Collection)

currency_unit

string

必需

Currency Unit (Only available for Collection)

custom_attribute

object

必需

Custom Attributes. Display custom data in API components.

var1

string

必需

Customize in the Workflow API Node

var2

string

必需

Customize in the Workflow API Node

call

object

必需

Outbound Call Attributes

task_id

string

Task ID

必需

call_id

string

必需

The unique ID of the call

call_start_time

string

必需

Call Start Time, in the customer location time zone.

call_end_time

string

必需

Call End Time, in the customer location time zone.

call_times

integer

必需

Dialing Times

ring_type

enum<string>

必需

Ringing Type

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

hangup_type

enum<string>

必需

Hang up Type

枚举值:

ByCalleeByRobotCanceled

intention

必需

slots

string

必需

The slot info of the call (depends on the country/region)

multi_label

object

必需

Multi-intention Label

asr_ptp

string

必需

ASR found that the customer promised to pay back (Unavailable for Info-Checker)

asr_result

array [object {3}]

必需

ASR Results (Unavailable for Info-Checker)

示例

{
  "workflow_id": "f437fb6aa75042ee973ebb23e7d3b1b9",
  "workflow_name": "huida_test_api_002",
  "node_id": "04e19e53f694496f8774355e2096d9f1",
  "node_name": "API1",
  "callee": {
    "case_id": "",
    "callee_name": "WILL SMITH1",
    "callee_gender": "male",
    "location": "Silicon Valley",
    "callee_number": "+6212345678",
    "platform_name": "WY",
    "extra_a": "",
    "extra_b": "",
    "extra_c": "",
    "extra": [
      {
        "Content": "codLogistics260",
        "Question": "order_type"
      },
      {
        "Content": "TG",
        "Question": "lang"
      }
    ],
    "extend": {
      "variables": {
        "test": "xxx",
        "extra_a": "hello world"
      }
    },
    "comments": "",
    "borrowed_date": "2019-02-01",
    "due_date": "2021-03-02",
    "borrowed_amount": "20000.00",
    "total_owing_amount": "20310.23",
    "currency_unit": "USD"
  },
  "custom_attribute": {
    "a": "1",
    "b": "2"
  },
  "call": {
    "task_id": "bd5d09be45f81fcff39ca616d38b7d79",
    "call_id": "d7b14e08214617f5d7066fc002e6b379",
    "call_start_time": "2022-12-29T09:01:52Z",
    "call_end_time": "2022-12-29T09:01:59Z",
    "call_times": 1,
    "ring_type": "normal",
    "hangup_type": "ByCallee",
    "intention": "",
    "slots": "",
    "multi_label": {},
    "asr_ptp": "",
    "asr_result": [
      {
        "time": "00:00:00",
        "robottext": "selamat sore",
        "text": "halo halo"
      },
      {
        "time": "00:00:09",
        "robottext": "Saya Daniel dari adakami",
        "text": "halo halo halo halo"
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'The party provides this url to configure in the workflow.' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "f437fb6aa75042ee973ebb23e7d3b1b9",
    "workflow_name": "huida_test_api_002",
    "node_id": "04e19e53f694496f8774355e2096d9f1",
    "node_name": "API1",
    "callee": {
        "case_id": "",
        "callee_name": "WILL SMITH1",
        "callee_gender": "male",
        "location": "Silicon Valley",
        "callee_number": "+6212345678",
        "platform_name": "WY",
        "extra_a": "",
        "extra_b": "",
        "extra_c": "",
        "extra": [
            {
                "Content": "codLogistics260",
                "Question": "order_type"
            },
            {
                "Content": "TG",
                "Question": "lang"
            }
        ],
        "extend": {
            "variables": {
                "test": "xxx",
                "extra_a": "hello world"
            }
        },
        "comments": "",
        "borrowed_date": "2019-02-01",
        "due_date": "2021-03-02",
        "borrowed_amount": "20000.00",
        "total_owing_amount": "20310.23",
        "currency_unit": "USD"
    },
    "custom_attribute": {
        "a": "1",
        "b": "2"
    },
    "call": {
        "task_id": "bd5d09be45f81fcff39ca616d38b7d79",
        "call_id": "d7b14e08214617f5d7066fc002e6b379",
        "call_start_time": "2022-12-29T09:01:52Z",
        "call_end_time": "2022-12-29T09:01:59Z",
        "call_times": 1,
        "ring_type": "normal",
        "hangup_type": "ByCallee",
        "intention": "",
        "slots": "",
        "multi_label": {},
        "asr_ptp": "",
        "asr_result": [
            {
                "time": "00:00:00",
                "robottext": "selamat sore",
                "text": "halo halo"
            },
            {
                "time": "00:00:09",
                "robottext": "Saya Daniel dari adakami",
                "text": "halo halo halo halo"
            }
        ]
    }
}'

请求参数

示例代码

返回响应