Sign in
ivrs

Get a specific scenario for an IVR

Retrieves detailed information about a specific scenario within an IVR. The response includes the full call flow definition — menu steps, routing rules, audio prompts, and queue configuration. Both ivrId and scenarioId must match for the scenario to be returned.

Permission: IVRs Read required.

Monitoring impact:

  • OFF: Returns the scenario only if the parent IVR is assigned to you. Returns 404 otherwise.
  • ON: Returns any scenario for any IVR in the team.
get/ivrs/{ivrId}/scenarios/{scenarioId}

Path parameters

ivrIdinteger required

The unique identifier of the IVR. Use GET /ivrs to discover available IVR IDs.

scenarioIdinteger required

The scenario identifier

Response

Successful operation — returns the scenario details.

scenario_idinteger

The scenario identifier

ivr_idinteger

The unique identifier of the IVR. Use GET /ivrs to discover available IVR IDs.

namestring

The name of the scenario

colorstring
scenario_type'menu' | 'announce' | 'queue' | 'sms' | 'webhook' | 'input'

The type of the scenario

is_defaultboolean

Example response

{
  "scenario_id": 123456,
  "ivr_id": 1234,
  "name": "myscenario",
  "color": "123456",
  "scenario_type": "menu",
  "is_default": true
}