Skip to main content
PUT
Set phone-menu navigation
Phone-menu navigation is an agent setting: it applies to the calls of every task in the agent. It is off by default. When it is on and a call reaches a phone menu or a switchboard, the agent:
  • Waits for a live voice before saying its opening line, and stays silent on menus, recordings, and hold music.
  • Presses keys toward the person who can act on the call’s goal: an extension, dial-by-name, the operator (0), or the closest department. In a dial-by-name directory, it enters the contact’s name on the keypad.
  • After a menu, asks the receptionist for the contact by name.
  • Goes back with * when an option leads nowhere useful.
  • Leaves one voicemail with its callback number when only a mailbox fits.
Turn it on for agents that call businesses, where menus answer most calls. Leave it off for agents that call people on their own phones.
Read the current value in ivr_navigation from List agents.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.

Path Parameters

id
string<uuid>
required

Agent ID (master_workflow in the API).

Body

application/json
ivr_navigation
boolean
required

true turns phone-menu navigation on, false turns it off.

Response

Saved value.

id
string<uuid>
required
ivr_navigation
boolean
required
Last modified on October 2, 2026