Notification

post

https://api.cm.com/voiceapi/v2/notification

Send out a Voice Notification message.

Recipes

🦉

Sending a Voice Notification

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🦉

Sending a Voice Notification

Open Recipe

Application flow

Voicemail detection

You can also determine the action when voicemail has been detected, by setting the property voicemail-response in your request. The following settings are supported:

Value	Description
Ignore	Do not detect voicemail. Default value when voicemail-response is not set in your request.
Restart	Restarts the whole prompt.
Stop	Stops the call.

Body Params

Details of the notification instruction.

instruction-id

string | null

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).

callee

string | null

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

callees

array of strings | null

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.

callees

caller

string

required

length between 1 and 24

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

anonymous

boolean

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

callback-url

uri | null

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

max-ringing-timeout

int32 | null

10 to 60

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.

prompt

string

required

length between 1 and 750

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

prompt-type

string

enum

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

Allowed:

voice

object

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

voicemail-response

string

enum

The type that determines the flow of Voicemail detection.

Allowed:

max-replays

int32 | null

0 to 3

The number of times the Notification can be replayed.

auto-replay

boolean | null

Whether to automatically replay the Notification. Defaults to false.

replay-prompt

string | null

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.

replay-prompt-type

string

enum

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

Allowed:

Responses

401

Unauthorized

Application flow

Voicemail detection

200Call is queued

400Bad Request