post https://connect.routee.net/voice/campaign
Send a Voice messaging campaign to multiple recipients. This is a paid service. For pricing check here
Response Parameters
| KEY | DESCRIPTION |
|---|---|
| callback | Defines the notification callback information for an individual message progress of the Voice campaign. Check here for more details. |
| callback.strategy | When the URL will be called, on every status change (OnChange) or when a final status arrives (OnCompletion) |
| callback.url | The URL that will be called when an update occurs |
| campaignCallback | Information about a DLR callback for the progress of the Voice campaign. |
| campaignCallback.strategy | When the URL will be called, on every status change (OnChange) or when a final status arrives (OnCompletion) |
| campaignCallback.url | The URL that will be called when an update occurs |
| campaignName | The name of the campaign |
| contacts | The contacts list |
| cost | The cost of the campaign |
| createdAt | The time the campaign was created |
| fileURL | The url of the wav file to play |
| from | The sender id |
| groups | The groups |
| hangupDelay | The time to wait for the call to be answered |
| message | Represents the text message to be converted to wav file |
| message.gender | The gender of the voice message. Check here for possible values |
| message.language | The language of the voice message. Check here for possible values |
| message.text | The text of the voice message |
| respectQuietHours | Indicates if the Voice message should respect the quiet hours. |
| scheduledDate | The date the campaign was scheduled to run |
| state | The status of the campaign |
| statuses | Defines the number of voice messages per status. Check here for details. |
| to | The recipients' numbers. |
| trackingId | The tracking id of the campaign |
| type | The service type of the campaign |
| collectDtmfDigits | Indicates if the voice campaign should collect DTMF digits at the end of the voice message. |
| collectDtmfAwaitSeconds | If you enable the collectDtmfDigits you can set the duration of the pause that will be added at the end of the voice message. |
| voiceAnalysis | Contains information for a voice call after being analyzed |
| voiceAnalysis.contacts | The details of each contact. The key refers to the id of the contact given in the request. |
| voiceAnalysis.dialPlanAnalysis | |
| voiceAnalysis.dialPlanAnalysis.placeholder | |
| voiceAnalysis.numberOfRecipients | The total number of recipients |
| voiceAnalysis.recipientCountries | For each recipient the country that the mobile belongs to (country format in ISO 3166-1 alpha-2) |
| voiceAnalysis.recipientsPerCountry | The total recipients per country (country format in ISO 3166-1 alpha-2) |
| voiceAnalysis.recipientsPerGroup | For each group the number of recipients that it contains without the blacklisted contacts |
| voiceAnalysis.totalInGroups | The total number of recipients in all given groups excluding the ones already specified and the blacklisted |
| errors.code | The code of error |
| errors.developerMessage | Message of error |
| errors.property | The numbers of invalid recipients |
ERROR CODES
| Status | Code | Description |
|---|---|---|
| 403 | User is not authenticated | |
| 404 | User is not found |