ivrs

List scenarios for a specific IVR

Changed on

Retrieves all scenarios (call flow variants) attached to a specific IVR. A scenario defines a complete call flow — which menu options are available, how calls are routed, and what happens at each step. An IVR typically has one default scenario but can have multiple variants for different contexts (e.g., business hours vs. after-hours). The total count is in the list_count field.

Permission: IVRs Read required.

Monitoring impact:

  • OFF: Returns only scenarios from IVRs assigned to you.
  • ON: Returns all scenarios for the specified IVR.
get/ivrs/{ivrId}/scenarios

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/ivrs/{ivrId}/scenarios
  • Auth
    API key in header Authorization

Path parameters

ivrIdinteger required

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

Response

Successful operation — returns the list of scenarios.

list_countinteger

The size of the list

Example response

{
  "list_count": 1,
  "list": [
    {
      "scenario_id": 123456,
      "ivr_id": 1234,
      "name": "myscenario",
      "color": "123456",
      "scenario_type": "menu",
      "is_default": true
    }
  ]
}

Changes