List Call Campaigns
Retrieve paginated list of call campaigns
List
Details
| Description | The "List" endpoint provides detailed information about call campaigns. |
|---|---|
| HTTP Method | GET |
| Endpoint URL | https://platform.innocalls.com/v1/api-gateway/call-campaign/list |
| Authorization | To access the API endpoints, you need to authenticate using API keys and API secrets. The API supports Basic Authentication for authorization. You need to include your API ID as the username and your API secret as the password in the HTTP header when making requests. Replace API_ID with your API ID and API_SECRET with your API secret, separated by a colon (:). The value after Basic is the Base64 encoding of your API key and API secret concatenated with a colon. |
| Rate Limit | 3 requests per second |
Request Parameters
| Parameter | Description | Location | Constrains | Default Values |
|---|---|---|---|---|
| limit | Limit of fetched rows | Query | Optional Max: 100 | 10 |
| page | Page of rows to fetch | Query | Optional Min: 1 | 1 |
Request Example
curl 'https://platform.innocalls.com/api/v1/api-gateway/call-campaign/list?page=1&limit=10' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>'Success Response Example
{
"data": {
"rows": [
{
"id": "6586b1c1ec82330a1439d9a7",
"name": "name",
"description": "description",
"requiredVariables": [
{
"variableName": "test",
"type": "money"
}
],
"trialsCount": 1,
"minutesToWaitBeforeFirstTrial": 0,
"delayMinutesBetweenTrials": 5
}
],
"totalItems": 1,
"totalPages": 1
}
}Description
This JSON response confirms a successful retrieval of a list containing detailed information about each call campaig
totalItems: Total number of call campaigns.totalPages: Total pages of call campaigns.rows: An array containing details of each call campaign.id: Unique identifier for the call campaign.name: Name of the call campaign.description: Description of the call campaign.trialsCount: Number of trials count of the call campaign.minutesToWaitBeforeFirstTrial: Minutes to wait before first trial.delayMinutesBetweenTrials: Delay minutes between each trial.requiredVariables: The required variables of the call campaign. It can be empty or an array of objects depending on call campaign required variables.variableName: Variable name.type: Variable type.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
