API Reference

DTMF

post
https://api.cm.com/voiceapi/v2/dtmf

Send out a call that requests DTMF input from the callee.

Recipes
🦉
Create a request DTMF call
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🦉
Create a request DTMF call
Open Recipe

Application flow

Voicemail detection

🚧

Important note

Voicemail detection is not available for DTMF.

Body Params

Details of the DTMF instruction.

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

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

boolean

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

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.

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.

string
required
length between 1 and 1000

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.

string
enum

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

Allowed:
string
required
length between 1 and 1000

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.

string
enum

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

Allowed:
string | null

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

string
enum

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

Allowed:
int32 | null
1 to 64

The minimum number of digits for the dtmf input.

int32 | null
1 to 64

The maximum number of digits for the dtmf input.

int32 | null
1 to 10

The maximum number of attempts to input valid dtmf.

int32 | null
1000 to 10000

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.

string | null

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

string | null

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

voice
object

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

string
enum

The type that determines the flow of Voicemail detection.

Allowed:
Responses

401

Unauthorized

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago