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

Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)

Production
https://api.airudder.com
Production
https://api.airudder.com
POST
/service/cloud/workflow/taskdetail
To retrieve the call details of the phone numbers within an outbound task (task_id), use the API endpoint. This endpoint provides similar information to the /service/cloud/detail endpoint, but with added workflow-related data: "workflow_id", "workflow_name", "nodetask_id", "nodetask_name", and "case_id". All returned fields have the same meanings as the "Notification of Call Completion in Workflow" description.

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
task_id
string 
required
Outbound task ID can be obtained from /service/cloud/workflow/tasklist.
Example
{
    "task_id": "1def98dc9c8c72449ab55d6ec22c2e68"
}

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/taskdetail' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "task_id": "1def98dc9c8c72449ab55d6ec22c2e68"
}'

Responses

🟢200success
application/json
Body
data
object 
required
TaskID
string 
required
Outbound call task ID.
TaskName
string 
required
Outbound call task name.
RobotMethod
enum<string> 
required
The type of the used robot.
Allowed values:
singlegroup
Default:
single
RobotID
string 
required
The ID of the used robot.
SIPLine
string 
required
Name of the line used.
Status
enum<string> 
required
Task status.
Allowed values:
createdpendingfinishedcallingcanceledpaused
ScheduleStartTime
string 
required
The estimated start time of the task. The returned time is in UTC +00:00 timezone.
ScheduleEndTime
string 
required
The estimated end time of the task. The returned time is in UTC +00:00 timezone.
RepeatInterval
integer 
required
Repeated call time interval, measured in minutes.
RepeatNumber
integer 
required
Number of repeated call attempts.
detail
array [object {34}] 
required
wokflow_id
string 
required
Workflow uniquely id
workflow_name
string 
required
Workflow name
nodetask_id
string 
required
Workflow node details ID, no need to follow
nodetask_name
string 
required
Workflow node task name, no need to follow
status
string 
required
code
integer 
required
Example
{
    "data": {
        "TaskID": "88ee39e17xxxxxxxxxe9cf739cfdc6697",
        "TaskName": "wf_test_api_webhook1_Voicebot Call1_a33a08",
        "RobotMethod": "single",
        "RobotID": "c65f105edf4c1xxxxxxxxxfe4e2c39",
        "SIPLine": "CH_xxxxxxxxxxxxxHK_LINE",
        "Status": "finished",
        "ScheduleStartTime": "2024-03-11T08:38:35.113221Z",
        "ScheduleEndTime": "2024-03-11T09:11:35.113221Z",
        "RepeatInterval": 0,
        "RepeatNumber": 3,
        "detail": [
            {
                "id": 2125380211,
                "RobotID": "4585",
                "CalleeName": "WILL SMITH",
                "CalleeGender": "",
                "CalleeNumber": "+86xxxxxxxxx5721",
                "CallStartTime": "2024-03-11T08:41:26Z",
                "CallEndTime": "2024-03-11T08:41:38Z",
                "Status": "finished",
                "Intention": "E",
                "CallID": "8dc0ed3f2xxxxxxxxxc1978c495",
                "CallTimes": 4,
                "Comments": "123456.0",
                "BorrowedDate": "2024-02-01",
                "DueDate": "2024-03-07",
                "BorrowedAmount": 20000,
                "TotalOwingAmount": 20310,
                "CurrencyUnit": "USD",
                "PlatformName": "AIRUDDER",
                "RingType": "normal",
                "HangupType": "ByCallee",
                "ExtraA": "",
                "ExtraB": "",
                "ExtraC": "",
                "AsrResult": [
                    {
                        "time": "00:00:00",
                        "robottext": "halo (jeda 1-2 detik) selamat siang",
                        "text": ""
                    },
                    {
                        "time": "00:00:03",
                        "robottext": "Apa boleh minta waktunya sebentar?",
                        "text": "halo halo ya ya ya ya ya ya ya ya"
                    },
                    {
                        "time": "00:00:09",
                        "robottext": "",
                        "text": ""
                    },
                    {
                        "time": "00:00:09",
                        "robottext": "Iya, halo",
                        "text": ""
                    },
                    {
                        "time": "00:00:10",
                        "robottext": "Ada tagihan anda yang sedang jatuh tempo,  bisa diinfokan rencana pembayaran Anda?",
                        "text": ""
                    }
                ],
                "RingTime": 2,
                "TalkRound": 1,
                "RedailCall": [
                    {
                        "CallID": "828bd366xxxxxxxxxca9c58d7f5b",
                        "CallStartTime": "2024-03-11 15:38:36",
                        "RingType": "normal",
                        "RingTime": 0,
                        "HangupType": "ByCallee",
                        "ResultLabel": "F",
                        "callee_number": "+861xxxxxxxxx95",
                        "caller_number": "+95xxxxxxxxx0088"
                    },
                    {
                        "CallID": "d7fa4f0b05xxxxxxxxx50230575d",
                        "CallStartTime": "2024-03-11 15:39:27",
                        "RingType": "normal",
                        "RingTime": 9,
                        "HangupType": "ByCallee",
                        "ResultLabel": "F",
                        "callee_number": "+861xxxxxxxxx21",
                        "caller_number": "+95xxxxxxxxx088"
                    },
                    {
                        "CallID": "d1398b0axxxxxxxxx3e5f2c12",
                        "CallStartTime": "2024-03-11 15:40:24",
                        "RingType": "normal",
                        "RingTime": 0,
                        "HangupType": "ByCallee",
                        "ResultLabel": "F",
                        "callee_number": "+86xxxxxxxxx95",
                        "caller_number": "+95xxxxxxxxx088"
                    }
                ],
                "NerSlots": {
                    "PaymentMethod": "Transfer",
                    "PaymentTime": "Time_0"
                },
                "intention_description": "Needs Follow Up",
                "EventLabel": {
                    "A0": "A0",
                    "Correct_Person": "identity_correct_person",
                    "Request_Installment": "action_item_request_installment"
                },
                "caller_number": "+95xxxxxxxxx88",
                "case_id": "123456.0"
            }
        ],
        "workflow_id": "61eff70exxxxxxxxx1bfcbb6a58ea",
        "workflow_name": "test_api_webhook1",
        "nodetask_id": "4e845e42bxxxxxxxxx136128530f86",
        "nodetask_name": "Voicebot Call1"
    },
    "status": "OK",
    "code": 200
}
Modified at 2024-05-28 11:22:53
Previous
Obtain the Outbound Task List of Workflow
Next
Obtain the Outbound Task Details of Workflow(Info Check)
Built with