Send a Voice Campaign

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

Body Params

from

string

required

The sender id for this call. The sender id can be a telephone number or an alphanumeric string. NOTICE: Alphanumeric sender is not supported by all networks (e.g. Greek networks). Check restrictions and features here: https://go.routee.net/#/management/restrictions-and-features

array of strings

The recipients of this call, must be a list with valid numbers (mobiles or landlines). Max length: 1000. One of "groups", "to", "contacts" parameters are required.

contacts

array of strings

The contacts of this call, must be a list with valid contact ids. Max length: 1000. One of "groups", "to", "contacts" parameters are required.

contacts

groups

array of strings

The lists of this call, must be a list with valid group names. Max length: 1000. One of "groups", "to", "contacts" parameters are required.

groups

name

string

The name of the voice campaign. The name of the campaign. If you want to be able to track the whole campaign from Routee web platform use a name. Must be between 2 and 30 characters and contain only latin letters, numbers, spaces and -

fileURL

string

The url of the wav file to play. One of fileURL or message parameters is required.

message

object

Represents the text message to be converted to speech. One of fileURL or message parameters is required.

respectQuietHours

boolean

Defaults to false

Indicates if the call should respect the quiet hours, default value: false.

ignoreDnd

boolean

Use this option when sending transactional messages. By enabling this option, Routee will ignore any Do Not Disturb list and will send the campaign to all the recipients you have provided. This option may violate user privacy.

scheduledDate

date

The date and time (in UTC), that the call campaign will be executed at. (eg YYYY-MM-DDThh:mm:ssTZD where TZD is the time zone designator (Z or +hh:mm or -hh:mm))

hangupDelay

int32

Defaults to null

The time to wait for the call to be answered

campaignCallback

object

Information about a DLR callback for the progress of the Voice campaign.

callback

object

Defines the notification callback information for an individual message progress of the Voice campaign

collectDtmfDigits

boolean

Defaults to false

Indicates if the voice campaign should collect DTMF digits at the end of the voice message.

collectDtmfAwaitSeconds

int32

Defaults to 10

If you enable the collectDtmfDigits you can set the duration of the pause that will be added at the end of the voice message.

Headers

Content-Type

string

required

Defaults to application/json

application/json

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Responses

Language

Request

Response

Choose an example:

application/json

200200

400400