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(Info Check)

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/ic_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": "ic31063fbcc5205b29f4ec38f7ed9d8a"
}

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": "ic31063fbcc5205b29f4ec38f7ed9d8a"
}'

Responses

🟢200success
application/json
Body
data
object 
required
task_id
string 
required
Task ID.
task_name
string 
required
Task name.
status
enum<string> 
required
Allowed values:
createdpendingfinishedcallingcanceledpaused
created_at
string 
required
Task creation time, in account's time zone.
repeat_interval
integer 
required
Repeated call time interval, measured in minutes.
repeat_number
integer 
required
Number of repeated call attempts.
robot_hash
string 
required
Robot hash ID.
robot_method
enum<string> 
required
Type of robot used.
Allowed values:
singlegroup
Default:
single
sip_line
string 
required
Name of the line used.
schedule_start_time
string 
required
Estimated start time of the task, in account's time zone.
schedule_end_time
string 
required
Estimated end time of the task, in account's time zone.
details
array [object {22}] 
required
workflow_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": {
        "task_id": "fe9aa56cc7cb9820a3b774860fea784b",
        "task_name": "wf_test_api_action2_Voicebot Call1_ffb68c",
        "status": "finished",
        "created_at": "2024-03-11 16:43:40",
        "repeat_interval": 0,
        "repeat_number": 2,
        "robot_hash": "a37e555f38184053687ebca7ac3575d8",
        "robot_method": "single",
        "sip_line": "CH_SOFTPHONE_Lyntest_HK_LINE",
        "schedule_start_time": "2024-03-11 16:44:04",
        "schedule_end_time": "2024-03-11 17:15:40",
        "details": [
            {
                "id": 2125574058,
                "callee": "+8618717905721",
                "result": "finished",
                "result_label": "N",
                "duration": 21,
                "hangup_type": "ByCallee",
                "ring_type": "normal",
                "question_answer": [
                    {
                        "question_name": "Q0",
                        "answer": "/",
                        "answer_text": "no",
                        "status": "Completed",
                        "answer_text_slot": "-",
                        "var": "-",
                        "verification_results": "-",
                        "question_content": "意愿确认 Willingness Check",
                        "question_type": "whether",
                        "whether_answer": "Invalid"
                    },
                    {
                        "question_name": "Q1",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "-",
                        "var": "-",
                        "verification_results": "-",
                        "question_content": "姓名确认 NameCheck",
                        "question_type": "whether",
                        "whether_answer": "Skip"
                    },
                    {
                        "question_name": "Q2",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "-",
                        "var": "-",
                        "verification_results": "-",
                        "question_content": "贷款人确认 BorrowerCheck",
                        "question_type": "whether",
                        "whether_answer": "Skip"
                    },
                    {
                        "question_name": "Q3",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "/",
                        "var": "200",
                        "verification_results": "/",
                        "question_content": "CURP核验 CURP Verification",
                        "question_type": "open",
                        "whether_answer": "Skip"
                    },
                    {
                        "question_name": "Q3N",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "/",
                        "var": "200",
                        "verification_results": "/",
                        "question_content": "CURP再次核验 CURP Reverification",
                        "question_type": "open",
                        "whether_answer": "Skip"
                    },
                    {
                        "question_name": "Q4",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "/",
                        "var": "1101",
                        "verification_results": "/",
                        "question_content": "生日核验 DoB Verification",
                        "question_type": "open",
                        "whether_answer": "Skip"
                    },
                    {
                        "question_name": "Q4N",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "/",
                        "var": "1101",
                        "verification_results": "/",
                        "question_content": "生日再次核验 DoB Reverification",
                        "question_type": "open",
                        "whether_answer": "Skip"
                    },
                    {
                        "question_name": "Q5",
                        "answer": "/",
                        "answer_text": "",
                        "status": "Skip",
                        "answer_text_slot": "/",
                        "var": "200",
                        "verification_results": "/",
                        "question_content": "CURP2位核验 CURP Verification for 2 character",
                        "question_type": "open",
                        "whether_answer": "Skip"
                    }
                ],
                "NerSlots": {
                    "PaymentMethod": "Transfer",
                    "PaymentTime": "Time_0"
                },
                "robot_hash": "a37e555f38184053687ebca7ac3575d8",
                "call_id": "icd46170cef87282b2c7792caf399583",
                "call_times": 2,
                "call_start_time": "2024-03-11 16:46:32",
                "call_end_time": "2024-03-11 16:46:53",
                "ring_time": 5,
                "talk_round": 1,
                "redail_call": [
                    {
                        "call_id": "ic1c5d8ed11ea4f314319df3cc70c333",
                        "call_start_time": "2024-03-11 16:45:29",
                        "ring_type": "normal",
                        "ring_time": 2,
                        "hangup_type": "ByCallee",
                        "result_label": "F",
                        "callee_number": "+8618717905721",
                        "caller_number": "+9501359900088"
                    }
                ],
                "intention_description": "Hangup During Check Question",
                "EventLabel": {
                    "A0": "A0",
                    "Correct_Person": "identity_correct_person",
                    "Request_Installment": "action_item_request_installment"
                },
                "caller_number": "+9501359900088",
                "case_id": ""
            }
        ],
        "workflow_id": "9f81e1774adf4bf7aed637bdc771a74a",
        "workflow_name": "test_api_action2",
        "nodetask_id": "aa9a4f4944e8411aad4b69044972f90d",
        "nodetask_name": "Voicebot Call1"
    },
    "status": "OK",
    "code": 200
}
Modified at 2024-05-28 11:23:04
Previous
Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)
Next
Obtain Call Information and Recording Links by callee/caseid and taskid/workflow_id
Built with