Sign in
latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

ivrs

Get a specific scenario by ID

Retrieves a specific scenario by its unique ID, regardless of which IVR it belongs to. This is a shortcut alternative to GET /ivrs/{ivrId}/scenarios/{scenarioId} when you already know the scenario ID but not the parent IVR ID.

Permission: IVRs Read required.

Monitoring impact:

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

Path parameters

scenarioIdinteger required

The unique identifier of the scenario

Response

Successful operation

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
}