API Reference
  1. Call Routing

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Menu name.

string | null

Free-text description.

string | null

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

string | null

Greeting played when the menu answers the call.

string | null

Prompt played when the caller presses something the menu does not offer.

string | null

Prompt played as the menu exits.

string | null

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

string | null

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

string | null

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

number | null

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

number | null

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

number | null

How many invalid entries the menu accepts before it exits.

number | null

How many silent timeouts the menu accepts before it exits.

boolean | null

Whether callers may dial an extension directly from the menu.

string | null

Ringback tone or file played to the caller.

string | null

Caller-ID prefix added to calls leaving the menu.

number | null

Ordering hint for display.

string

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

string | null

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

string | null

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

Responses

401

Missing or invalid API key.

Updated about 6 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?