Send a Voice Campaign

Send a Voice messaging campaign to multiple recipients. This is a paid service. For pricing check here

Response Parameters

KEYDESCRIPTION
callbackDefines the notification callback information for an individual message progress of the Voice campaign. Check here for more details.
callback.strategyWhen the URL will be called, on every status change (OnChange) or when a final status arrives (OnCompletion)
callback.urlThe URL that will be called when an update occurs
campaignCallbackInformation about a DLR callback for the progress of the Voice campaign.
campaignCallback.strategyWhen the URL will be called, on every status change (OnChange) or when a final status arrives (OnCompletion)
campaignCallback.urlThe URL that will be called when an update occurs
campaignNameThe name of the campaign
contactsThe contacts list
costThe cost of the campaign
createdAtThe time the campaign was created
fileURLThe url of the wav file to play
fromThe sender id
groupsThe groups
hangupDelayThe time to wait for the call to be answered
messageRepresents the text message to be converted to wav file
message.genderThe gender of the voice message. Check here for possible values
message.languageThe language of the voice message. Check here for possible values
message.textThe text of the voice message
respectQuietHoursIndicates if the Voice message should respect the quiet hours.
scheduledDateThe date the campaign was scheduled to run
stateThe status of the campaign
statusesDefines the number of voice messages per status. Check here for details.
toThe recipients' numbers.
trackingIdThe tracking id of the campaign
typeThe service type of the campaign
collectDtmfDigitsIndicates if the voice campaign should collect DTMF digits at the end of the voice message.
collectDtmfAwaitSecondsIf you enable the collectDtmfDigits you can set the duration of the pause that will be added at the end of the voice message.
voiceAnalysisContains information for a voice call after being analyzed
voiceAnalysis.contactsThe details of each contact. The key refers to the id of the contact given in the request.
voiceAnalysis.dialPlanAnalysis
voiceAnalysis.dialPlanAnalysis.placeholder
voiceAnalysis.numberOfRecipientsThe total number of recipients
voiceAnalysis.recipientCountriesFor each recipient the country that the mobile belongs to (country format in ISO 3166-1 alpha-2)
voiceAnalysis.recipientsPerCountryThe total recipients per country (country format in ISO 3166-1 alpha-2)
voiceAnalysis.recipientsPerGroupFor each group the number of recipients that it contains without the blacklisted contacts
voiceAnalysis.totalInGroupsThe total number of recipients in all given groups excluding the ones already specified and the blacklisted
errors.codeThe code of error
errors.developerMessageMessage of error
errors.propertyThe numbers of invalid recipients

ERROR CODES

StatusCodeDescription
403User is not authenticated
404User is not found
Language