Quick Start - AIRUDDER API

The document introduces the API interfaces recommended for different scenarios. You can select the APIs that you want to use according to your needs.

When the lists only needs to be followed up once, and the results generated do not need to be followed up automatically, then the [APIs Related to Calling Tasks] are recommended;

APIs	Descriptions
Create a Calling Task	Create a Calling Task
List the Task Created	Get your task listed by pagination. Tasks listed in descending order of Task Creation Time.
Cancel a Calling Task	Cancel a created task.
Cancel a Certain Call in a Specific Task	Cancel a certain call in a specific task.
Webhook of task	When the task ends, actively notify the counterparty that the task has ended.
Webhook of Call	When the call is finished (either connected or completed), regardless of whether it is connected or not, the counterparty will be notified of the call data for the task.
Obtain the Detailed Information of Tasks	Obtain the Detailed Information of Tasks according to TaskID.
Obtain a Call Recording	Using TaskID and Callee Number to get the call recording.
Obtain Task Recordings	Obtain task recordings in .mp3 files.

When the same lists need to be followed up using a simple strategy, for example, the lists with different intention labels needed to be followed up in a different way, then the [APIs Related to Calling Plans] are recommended, among which, the strategy needs to be created from the iCall website.

APIs	Descriptions
Obtain the List of Strategies	Obtain the list of strategies created in the website.
Create a Dialing Plan with Strategy	Create a dialing plan with Strategy.
Obtain the Information of Plan Status	Obtain the current status of the plan.
Obtain the Information of Each Round of the Plan	Obtain the information of number of rounds, task name, task ID and task status in the plan.
List the Task Created	Get your task listed by pagination. Tasks listed in descending order of Task Creation Time.
Cancel a Calling Task	Cancel a created calling task.
Cancel a Certain Call in a Plan	Cancel the certain phone call in the whole plan.
Webhook of Plan	When all the tasks of the plan end, we will actively notify the counterparty that the plan has ended.
Webhook of Task	When the task ends, we will actively notify the counterparty that the task has ended.
Webhook of Call	When the task call finished (either connected or completed), regardless of whether it is connected or not, the counterparty will be notified of the call data for the task.
Obtain the Detailed Information of Tasks	Obtain the Detailed Information of Tasks according to TaskID.
Obtain a Call Recording	Using TaskID and Callee Number to get the call recording address. Only the recordings of last one month is available.
Obtain Call Recordings	Obtain task recording in .mp3 files. Only the recordings of latest one month is available.
Obtain All Call Records of a Number in the Plan	Using Plan Name and Callee Number to get all dialing recordings of the number in the plan.