ivrs

List IVRs (Interactive Voice Response)

Changed on

Retrieves all IVR (Interactive Voice Response) configurations for your team. An IVR defines an automated call flow — menu options, routing rules, welcome messages, business hours, and queue behavior. Each IVR has one or more scenarios (call flow variants). The total count is in the list_count field.

Permission: IVRs Read required.

Monitoring impact:

  • OFF: Returns only IVRs assigned to you (IVRs using your numbers).
  • ON: Returns all IVRs in the team.
get/ivrs

Request

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

Response

Successful operation — returns the list of IVRs.

list_countinteger

The size of the list

Example response

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

Changes

  • d92d55716cc3Revision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int64 for status

    • warning

      removed the optional property // from the response with the status

    • info

      api operation id getIvrs was added

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status