Quick Start

1. How to adjust the APIs using the docs?

1. Obtain the Token

Domain name：https://api.airudder.com。
You have to use the Token Authentication and Obtain API to obtain the Token and add it to the request header of other APIs. The token will expire after 24 hours. If you request again within the validation period, the 24-hour validation period will be recalculated.

Click theTry it outbutton to adjust the APIs online. Choose the Productionenvironment and fill in the Appkey and Appsecret in the Production Environment. And then click send to obtain the token.

2. Authenticaton Method

When you need to make additional API requests after obtaining the token, you need to add an Authorization field in the header. The value of the field should be Token Token value.

For example, if your token is "abcdefghijklmn", then your Authorization field would be Token abcdefghijklmn. Each account has a different token, it's important to ensure there is a space between "Token" and your actual token value.

If the token is incorrect or missing, you will be unable to send requests to other APIs.

3. Use the corresponding API to Invoke Relative Operations

Set your Authentication as theAuthorizationheader, and fill in other needed API fields to adjust the APIs.

2. iCall Platform Terminologies

Task：Call Task is the carrier of iCall platform calling a list of numbers. You need to create a Task to calling a list of numbers, so that there are some fields needed including phone numbers, etc. When creating a single-round call to a list of phone numbers, and no follow-up is needed for the result of one-round calls, then Task-related APIs are recommended.

Plan：Call Plan is the ordered combination of call tasks created with call strategies. It is perfect for executing multi-round calls for the same list of numbers. If you need to follow up the calls generated at the day with different call labels, the Plan-related APIs are recommended, among which the strategy used needs to be created on the iCall web platform.

Workflow ：Workflow is the automatic work flows that combine robot outbound call, outbound call strategy, and omnichannel. In the iCall platform, any type of workflow template can be created flexibly to carry out complicated work flows. Workflow is recommended to be utilized when the same load of numbers needed to be followed up separately, for example, follow them up based on various call labels, follow up on different days, follow up with multiple channels, human-bot collaboration, among which, the workflow template used should be created on the iCall web platform.