Skip to main content
Many business numbers answer with an automated menu: “Press 1 for sales, 2 for support…”. With IVR Menu Navigation on, an outbound agent that reaches such a menu presses keys or speaks keywords to get to the person or department you want, instead of hanging up. Navigation starts from the Answering Machine Detection verdict, so it requires AMD to be on. Switching AMD off switches navigation off with it, and the API refuses a request that would leave navigation on while AMD is off.

Turning it on

In the Dashboard or the Connect App, open an outbound agent’s settings and find IVR Menu Navigation, directly under Answering Machine Detection. Through the API, set ivrNavigation on Create Agent or Update Agent: true for the defaults, an object to tune it, false to turn it off.

Settings

The agent stays silent while it navigates, so every one of these limits is billed, silent call time. Set them a little above what the menus you call actually need.

How the call ends

The outcome is recorded on the call as ivr_navigation_outcome, shown next to the IVR menu badge in the Outbound Calls report, and sent on the result webhook. When navigation did not run on a call, the field is null.

Scripting a known menu per call

For a number you call often, you can skip the live navigation and press a fixed sequence of keys. Pass ivr_map when you trigger the call: an ordered list of steps that each wait for a menu phrase (wait_for) or a fixed delay (wait_ms), then press send_dtmf.
Up to 20 steps; each wait_ms is at most 60 seconds, send_dtmf is 1–32 digits (0-9, *, #), and the whole script must fit in 10 minutes including the presses. A script still needs AMD on for that call, since it is the menu verdict that starts it. A retry of the call reuses the same script. You can also override the agent’s navigation settings for one call with ivr_navigation on the same request.