Retrieving call campaign information
The following Calls API methods can be used to retrieve call campaign information:
GET /api/calls/campaign/{token}— detailed call campaign information.GET /api/calls/campaign/{token}/status— call campaign status.
Detailed call campaign information
Example request
curl https://platform.tovie.ai/api/calls/campaign/123.456.bAYxokdzmkWBZP2Tjcf4W0nzCpkC9L85mZQyd1OqJuv
Response content
The response will be a JSON object with the following properties:
| Property | Description |
|---|---|
id | Campaign ID. |
name | Campaign name. |
projectName | The ID of the project where the campaign was created. |
creationDate | Unix time when the campaign was created, in milliseconds. |
botId | Phone channel ID. |
status | Campaign status. |
shortReport | Statistical data on the campaign. |
startTime | Unix time when the campaign was started, in milliseconds. |
endTime | Unix time when the campaign was finished, in milliseconds. |
maxSimultaneousCalls | The number of simultaneous calls in the campaign. |
These are the shortReport properties:
| Property | Description |
|---|---|
totalNumbers | Total phone numbers in the campaign. |
processedNumbers | How many phone numbers were processed. |
usedTalkingTime | How many telephony seconds were used. |
usedAsrSeconds | How many ASR seconds were used. |
inProcessCalls | How many calls are in progress. |
retryCalls | How many calls were tried more than once. |
Call campaign status
Example request
curl https://platform.tovie.ai/api/calls/campaign/123.456.bAYxokdzmkWBZP2Tjcf4W0nzCpkC9L85mZQyd1OqJuv/status
Response content
The response will be a string indicating the campaign status:
plannedinProcessfinishedpauseddeleted