Voice API (v2)

Optional string that allows you to uniquely identify the placed outbound call. Its value is also included in the callback and Call Detail Records (CDRs).

The number to dial. When the number is invalid, the request will be rejected. Must be in valid international E.164 format.

List of multiple numbers to dial. When the list contains one or more invalid numbers, the request will be rejected. Must be in valid international E.164 format.

The caller ID to display on the recipient's phone. Must be in valid international E.164 format.

Indicates whether the caller ID should be hidden. Defaults to false.

URL that will be called when the call is finished. The body of this POST request will contain details about the call or calls.

Determines how long the Voice API will wait for the callee to answer the call. Cancels the ringing call after the timeout period exceeded. Defaults to 60.

The prompt to play which describes what DTMF input is requested from the callee. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

The prompt to play when the . This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

The prompt, which is either the path and name of the file to play, or the string that needs to be tts-ed.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

The minimum number of digits for the dtmf input.

The maximum number of digits for the dtmf input.

The maximum number of attempts to input valid dtmf.

The max. time in ms between the end of the prompt audio and the first digit, or between digits. If no digit is received before this timeout, it is counted as an attempt and the prompt is restarted. Value must be between 1000 and 10000 ms. Defaults to 5000.

The keys that will end dtmf input. Usually # or *. Defaults to #.

The regex to match the input against. An attempt will fail if the input does not match this regular expression. Defaults to [0-9]*.

The properties in this class are used to select the required TTS voice.

Optional string that allows you to uniquely identify the placed outbound call. Its value is also included in the callback and Call Detail Records (CDRs).

The number to dial. When the number is invalid, the request will be rejected. Must be in valid international E.164 format.

List of multiple numbers to dial. When the list contains one or more invalid numbers, the request will be rejected. Must be in valid international E.164 format.

The caller ID to display on the recipient's phone. Must be in valid international E.164 format.

Indicates whether the caller ID should be hidden. Defaults to false.

URL that will be called when the call is finished. The body of this POST request will contain details about the call or calls.

Determines how long the Voice API will wait for the callee to answer the call. Cancels the ringing call after the timeout period exceeded. Defaults to 60.

This property represents the unique identifier for a FlowBuilder flow. For guidance on locating the callflow ID of a specific flow, please refer to the FlowBuilder documentation.

Optional list of flow variables that will be set. For more information on FlowBuilder variables, please see the FlowBuilder documentation.

Optional string that allows you to uniquely identify the placed outbound call. Its value is also included in the callback and Call Detail Records (CDRs).

The number to dial. When the number is invalid, the request will be rejected. Must be in valid international E.164 format.

List of multiple numbers to dial. When the list contains one or more invalid numbers, the request will be rejected. Must be in valid international E.164 format.

The caller ID to display on the recipient's phone. Must be in valid international E.164 format.

Indicates whether the caller ID should be hidden. Defaults to false.

URL that will be called when the call is finished. The body of this POST request will contain details about the call or calls.

Determines how long the Voice API will wait for the callee to answer the call. Cancels the ringing call after the timeout period exceeded. Defaults to 60.

The prompt to play. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

The properties in this class are used to select the required TTS voice.

The type that determines the flow of Voicemail detection.

The number of times the Notification can be replayed.

Whether to automatically replay the Notification. Defaults to false.

Optional prompt instructing the callee to press 1 to replay the Notification. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

Optional string that allows you to uniquely identify the placed outbound call. Its value is also included in the callback and Call Detail Records (CDRs).

The number to dial. When the number is invalid, the request will be rejected. Must be in valid international E.164 format.

List of multiple numbers to dial. When the list contains one or more invalid numbers, the request will be rejected. Must be in valid international E.164 format.

The caller ID to display on the recipient's phone. Must be in valid international E.164 format.

Indicates whether the caller ID should be hidden. Defaults to false.

URL that will be called when the call is finished. The body of this POST request will contain details about the call or calls.

Determines how long the Voice API will wait for the callee to answer the call. Cancels the ringing call after the timeout period exceeded. Defaults to 60.

Optional prompt to play when the call is first answered. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

Optional prompt to play right before playing the actual OTP code. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager. This prompt is also replayed when the code is replayed.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

The code to read to the caller. Note that this code is read character per character, not as a word or number.

The type of the OTP code

Optional prompt instructing the callee to press 1 to replay the OTP. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

Optional prompt instructing the callee to press 1 to replay the Notification. This can be either TTS or SSML, or the path to an audio file in your Voice Audio Manager.

The type of the prompt, to distinguish between a filename and a string that needs to be tts-ed.

The number of times the OTP can be replayed.

Whether to automatically replay the OTP. Defaults to false.

The properties in this class are used to select the required TTS voice.