Create a phone menu

post

https://api.emaktalk.com/api/v1/ivr_menus

Creates a phone menu together with its key presses and its call routing. The number the menu answers on is allocated for you from your account's free range — an extension you send is ignored — and never falls in the reserved 10000–19999 range. The created menu's identity, including that number, comes back in the response, so you never have to find it again by name. Success is 200, not 201.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string | null

Menu name.

description

string | null

Free-text description.

language

string | null

en selects the US dialect and the Callie voice; any other value selects the Canadian dialect and the June voice.

greet_long

The greeting played when the menu answers. Takes a recording, a stock prompt or a phrase, as a sound reference: an object whose type is one of the types below. null plays no greeting.

greet_short

The shorter greeting played when the menu repeats itself. Takes a recording, a stock prompt or a phrase, as a sound reference: an object whose type is one of the types below. null plays the long greeting instead.

invalid_sound

Played when the caller presses a key the menu doesn't offer. Takes a recording or a stock prompt, as a sound reference: an object whose type is one of the types below. null plays nothing.

exit_sound

Played as the menu exits. Takes a recording or a stock prompt, as a sound reference: an object whose type is one of the types below. null plays nothing.

exit_app

string | null

Application the menu hands the call to when it exits. An empty string is stored as null.

exit_app_category

string | null

Labels the exit destination for the destination picker in the app; it never changes what the exit action does.

exit_data

string | null

Argument for the exit action, such as the destination it sends the call to.

confirm_attempts

number | null

How many times the menu asks the caller to confirm an entry.

timeout

number | null

How long the menu waits for the caller to press a key.

max_failures

number | null

How many invalid entries the menu accepts before it exits.

max_timeouts

number | null

How many silent timeouts the menu accepts before it exits.

direct_dial

boolean | null

Whether callers may dial an extension directly from the menu.

ringback

What the caller hears while a call sent on by the menu rings. Takes a recording, music on hold, an internet stream, a ringback tone or silence, as a sound reference: an object whose type is one of the types below. null leaves the ringback the call already has.

cid_prefix

string | null

Caller-ID prefix added to calls leaving the menu.

order

number | null

Ordering hint for display.

options

string

The menu's key presses: [{option_digits, option_action_category, option_action, option_param, option_order, option_description, option_enabled}].

domain

string | null

Reserved for internal use — omit it, and the menu is created on your own account.

extension

string | null

Ignored on create; the number the menu answers on is allocated for you.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The menu was created, and extension is the number it answers on.

403Your API key does not have the Admin role.

503try_again: your account's sounds couldn't be read just now, and nothing was changed. Wait the Retry-After seconds, then send the same request again.