Send advanced voice message

An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.

Maximum possible duration of the call to be set, shown in seconds.

Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additional one.

Additional client's data that will be sent on the notifyUrl. The maximum value is 700 characters. Example: Text containing some additional data needed in Delivery Report.

Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days property is mandatory. Days in the week are written as their full names: Monday-Sunday. Days parameter must be populated as a list, between two square brackets. Example: ['MONDAY', 'TUESDAY', 'WEDNESDAY']. From and to properties should be either both included, to allow finer time window granulation or both omitted, to include whole days in the delivery time window. From and to parameters are objects, that consist of hour and minute fields that hold integer values. For example, from: [ hour: 15, minute:45 ]. For complete json, please check out our example. Note: delivery time window is set in UTC timezone.

Message destination addresses. Destination address must be in the E.164 standard format (Example: 41793026727). Maximum number of destination addresses is 20k.

The waiting period for end user to enter DTMF digits. Default value is 10 seconds.

Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable.

If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found here. If not set, default language is English [en]. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is [Joanna].

Used for enabling detection of answering machine after the call has been answered. It can be set to hangup or continue. When set to hangup, if a machine is detected call will hang up. When set to continue, if a machine is detected, then voice message starts playing into voice mail after the answering message is finished with its greeting. If machineDetection is used, there is a minimum of 4 seconds detection time, which can result in delay of playing the message. Answering machine detection is additionally charged. For more information please contact your account manager and check documentation on Answering Machine Detection.

Defines the maximum number of DTMF codes entered by end user that would be collected.

Preferred Delivery report content type. Can be application/json or application/xml. Read more.

Specifies the version of the Delivery report to be sent. Can be 1 (deprecated version 1) or 2 (current version 2). The default is version 2. Read more.

The URL on your callback server on which the Delivery report will be sent.

Period of time in seconds between end user answering the call and message starting to be played. Minimal value is 0 and maximum value is 10 seconds. Default value is 0.

Specify DTMF code that is used as an indicator to repeat the voice message to the end user. The # key cannot be collected, as it is reserved for user input termination. Message can be repeated up to 5 times.

Used to define if the delivery of the Voice messages should be retried in case the first try doesn't succeed. Additional retries will be made according to the schedule defined by minPeriod and maxPeriod parameters and platform's internal retry logic. If the minPeriod differs maxPeriod, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached. If the retry attempt for the maxPeriod is reached, the maxPeriod will be used for all subsequent retries. If the minPeriod and the maxPeriod are defined as equal values, the period of time between retries will be equal to this value. Message delivery will be retried until the successful delivery or message validity or maxCount value is reached.

Ringing duration, unless there are no operator limitations. Default value is 45. Note: There are no limitations on the Voice platform regarding this value, however, most of the operators have their own ring timeout limitations and it is advisable to keep the ringTimeout value up to 45 seconds.

Used for scheduled Voice messages (message not to be sent immediately, but at scheduled time).

Sending rate defined in number of messages sent per second, minute, hour or day. First message will be sent immediately (or at sendAt time if scheduling is used) and subsequent messages will be sent respecting defined speed. For example, if sendingSpeed is defined as 10 messages per hour, messages will be sent every 6 minutes. If this parameter is defined, validityPeriod is ignored.

The reproduction speed of speech in the resulting message. Effective only when using text. Supported range is from 0.5 (slow down speech) to 2 (speed up speech). Values less than 0.5 will be replaced with 0.5, and values higher than 2 will be replaced with 2. Default value is 1.

Text of the message that will be sent. Message text can be up to 1400 characters long and cannot contain only punctuation. Adding pauses between the words and extending the duration of the voice message is possible by using the comma character “,”. For example, if you want to have a 3 second pause after each word, then the text parameter should look like this “one,,,,,,two,,,,,,three,,,,,,”. Each comma creates a pause of 0.5 seconds. SSML (Speech Synthesis Markup Language) is supported and can be used to fully customize pronunciation of the provided text.

The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).