Operations over voice campaigns
As the campaign creator, you have total control of its execution through operations like start, stop or cancel. All this is possible submitting PUT requests to the following URLs:
Note: if the campaign with the detailed unique id doesn’t exists, a error with the code VOICE-ERR-43 will arrive, indicating that the campaign must have “FAILED” or “PAUSED” status to execute the start operation.
Use example (using start operation, for the others is the same):
curl -ik -X PUT -H "Apikey: 70ea87b330fe4b82a9aee902fac05d23" -H "Apisecret: 8908028582"
Get campaign information
Where the uniqueCampaignId path parameter is the returned string when the campaign was created. This parameter can be used to get information about the campaign through the Campaign Info service; you can call it through the following GET service:
curl -ik -X GET -H "Apikey: 70ea87b330fe4b82a9aee902fac05d23" -H "Apisecret: 8908028582"
The parameters start and limit are used as paging parameters. i.e.
Start: 0 and Limit: 500 It will return the first 500 rows.
Start: 500 and Limit: 500 It will return rows from 500 to 1000.
Start: 1000 and Limit: 500 It will return rows from 1000 to 1500.
By default, start will be 0 and limit will be 500. The Campaign Info service returns a JSON with the following structure:
You can found the detailed structure of the JSON in the following table:
Code that identifies the error in the Voice Api Error Table.
Brief description of the error.
Indicates if the service response is successful or not.
Name assigned to the campaign.
Calculated cost of the campaign.
All the configuration info of the campaign, like call and time parametrization.
Details of each call in the campaign.
Voice campaign configuration object structure
The number that appears as the caller in the mobile destinations.
Low time limit where the campaign launches calls to the destinations, in 24 hours format e.g. 08:00.
Max time limit where the campaign launches calls to the destinations, in 24 hours format e.g. 22:00.
NRetries to a call destination, where it fails.
Time in minutes where each retry for a specific call destination is executed.
Define if the campaign continue with its execution in the next day, or it must finalize and omit all the remaining calls.
All the audios in the campaign will be played with the selected voice. In some cases (e.g. the API created campaigns) this voice is setted as UNKNOWN.
Set a text and the campaign will only plays its content.
Max concurrent calls in execution for the campaign.
Call Detail object structure
Mobile destination of the call.
First name of the destination person.
Last name of the destination person.
Duration of the call. It could be zero if the call hasn’t be executed.
Status of the call, it consider the following values: