List File Call Campaigns
Retrieve file-based campaign status and progress
List File Call
Details
| Description | The "List" endpoint retrieves details for files containing calls within a campaign. |
|---|---|
| HTTP Method | GET |
| Endpoint URL | https://platform.innocalls.com/v1/api-gateway/call-campaign/file-call/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 |
| timezone | Timezone for date conversion | Header | Optional | Asia/Riyadh |
Request Example
curl 'https://platform.innocalls.com/api/v1/api-gateway/call-campaign/file-call/list?page=1&limit=10' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>'Success Response Example
{
"data": {
"rows": [
{
"id": "656f2663dfecacf4e792f4e4",
"status": "cancelled",
"corruptedRows": 0,
"correctRows": 1,
"totalRows": 1,
"fileName": "test.csv",
"progress": 0,
"callCampaignCallScenario": "Call Campaign name"
}
],
"totalItems": 1,
"totalPages": 1
}
}Description
This JSON response signifies the successful retrieval of details for files containing calls within the call campaign. It provides comprehensive information about each file call within the campaign.
totalItems: Total number of single calls.totalPages: Total pages of single call details.rows: An array containing details of each individual file call.id: Unique identifier for the file call.status: Status of the file.callCampaignCallScenario: Name of the call campaign.corruptedRows: Total corrupted rows in the file.correctRows: Total correct rows in the file.totalRows: Total rows in the file.fileName: The uploaded file name.progress: Completion progress of the file.
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 |
| 400 BadRequest | This error occurs due to malformed or invalid request parameters |
