# AIRUDDER API ## Docs - [Introductions](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/doc-1549062.md): - [Quick Start](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/doc-1918333.md): - Error Codes [Error Codes](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/doc-1648295.md): ## API Docs - Get the Authorization token [Token Authentication and Obtain](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-44712004.md): Get token and add it to request header for other API. Token will be expired after 24 hours. If you applied again within validation period, the original token will be expired after another 24 hours. - Workflow > Webhooks of the Info of Predictive Dialer System [Webhook of Predictive Dialer Task Status Changes](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-50408764.md): The example in this unit shows the webhook info when the Task Status changes. - Workflow > Webhooks of the Info of Predictive Dialer System [Webhook of Predictive Dialer Contacts Status Changes](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-50409091.md): The example in this unit shows the webhook info when the Contacts Status changes. - Workflow > Webhooks of the Info of Predictive Dialer System [Webhook of Predictive Dialer Agents Status Changes](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-50406436.md): The example in this unit shows the webhook info when the Agents Status changes. - Workflow [Create a New WorkFlow Task](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45238811.md): Create a new WorkFlow Task. - Workflow [Obtain the List of Workflow Templates](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45229623.md): Obtain the list of Workflow Templates in reverse order of Creation Time. - Workflow [Add lists to an workflow task](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45244680.md): Add new lists to an existing workflow task. This is applicable when the call/reach process for the lists is the same, and the lists are generated by your business system in close succession. Please note the following when adding lists: - Workflow [Update the List Info of Workflow Task](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45246261.md): Update the information of specific lists within a workflow task. This is applicable when there are changes to the information of lists during the workflow execution. By using this interface, you can promptly update the information to ensure consistency between the information used for calling/reaching and your business system. It is generally recommended to upload the case ID during workflow creation to avoid any potential duplication of phone numbers. - Workflow [Cancel the processes for a specific list](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45246616.md): This interface is suitable for situations where there are changes to the information of lists during the workflow execution, and there is no need for further calling/reaching processes. By using this interface, you can cancel all subsequent processes for that particular list. When canceling a list, please consider the status of the workflow task. If it has already ended or been canceled, it will not be possible to cancel the list. Additionally, if all the processes within the workflow for that list have already been completed, it will also not be possible to cancel it. - Workflow [Notification of Call Completion in Workflow (Debt Collection/Marketing/E-commerce)](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45263573.md): When the phone call for a task is completed (connected or reaching the maximum dialing attempts), whether connected or not, notify the integrating party of the call data. - Workflow [Notification of Call Completion in Workflow(Info Check)](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-78672886.md): When the phone call for a task is completed (connected or reaching the maximum dialing attempts), whether connected or not, notify the integrating party of the call data. - Workflow [Custom API Node Data Push](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-154267240.md): 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). - Workflow [Verify the Custom API Node Data Push](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-58679239.md): 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.) - Workflow [Stop the Workflow Task](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45267515.md): Stop the workflow task. - Workflow [Obtain the Workflow Task List](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45268459.md): Obtain a list of workflow tasks, in reverse order of creation time. - Workflow [Obtain the Subtask List of the Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45275726.md): To obtain the subtask list information of a workflow instance, during the execution of a workflow task, each Action node will generate a subtask. A subtask may generate multiple outbound tasks (note the distinction between subtasks and outbound tasks). - Workflow [Obtain the Outbound Task List of Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-154087794.md): To obtain the all outbound task list information of a workflow instance, during the execution of a workflow task, each Action node will generate a subtask. A subtask may generate multiple outbound tasks (note the distinction between subtasks and outbound tasks). - Workflow [Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-154573225.md): 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. - Workflow [Obtain the Outbound Task Details of Workflow(Info Check)](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-154573421.md): 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. - Workflow [Obtain Call Information and Recording Links by callee/caseid and taskid/workflow_id](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-178718843.md): Obtain call information and recording links by using callee/caseid and taskid/workflow_id as parameters, Please note that only data from the previous 3 months can be queried. - Workflow [Obtian Call Information and Recording Link by Call ID](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-178718855.md): Obtian phone details and recording link based on the call ID. Only data from the last 3 months can be queried. - Workflow [Obtain All the Recordings of a Single Number in the Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-45279102.md): Obtain all the recordings of a single number in the workflow. - Workflow [Query workflow_id using case_id/callee](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-154088166.md): - Workflow [Notification for Workflow List Completion](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-154087917.md): When the list completes its flow within the workflow, notifications will be sent one by one to the configured URL. - Workflow [Notification of Workflow Status Change](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-178704796.md): Notify the integrating party proactively when the workflow status changes to "cancelled" and "finished". - Workflow [Obtain the WABA Tasks List of Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-236664191.md): Get the list of all WABA tasks generated within the workflow task. During the execution of a workflow task, each WABA Template node may generate multiple WABA tasks. - Workflow [Obtain the WABA Task Details of Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-236665438.md): Retrieve the list delivery status details of the WABA task based on the WABA task ID. - Workflow [Notification of WABA Message Status Alteration in Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-286285375.md): Proactively notify the integration party when the WABA message status changes sent from the WABA Template node within the Workflow. Each status change of a WABA message will be notified. - Workflow [Chatbot Session End Notification in Workflow](https://apifox.com/apidoc/shared/aea72e1c-0fb4-4aa9-a8a3-166c57bc7a64/api-286285407.md): In the Workflow, after sending a message through the WABA Template node, if the customer replies and triggers a Chatbot session bound to that template, when the conversation with the Chatbot ends, the system will proactively send a conversation end notification to the integration party. If the session involves a transfer to a human agent, wait for the transfer to complete and the session to fully end before notifying.