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

9da73dd2f99e

ivrs

Get an IVR by ID

Retrieves detailed information about a specific IVR by its identifier, including its configuration, assigned numbers, scenarios, welcome message settings, business hours, and queue parameters. Use GET /ivrs to discover available IVR IDs.

Permission: IVRs Read required.

Monitoring impact:

OFF: Returns the IVR only if it is assigned to you. Returns 404 otherwise.
ON: Returns any IVR in the team.

get/ivrs/{ivrId}

Path parameters

ivrIdinteger required

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

Response

Successful operation — returns the IVR details.

ivr_idinteger

The identifier of the ivr

namestring

The name of the ivr

color'ff6b6b' | 'F06292' | 'BA68C8' | '9575CD' | '7986CB' | '64B5F6' | '4FC3F7' | '4DD0E1' | '4DB6AC' | '81C784' | 'AED581' | 'DCE775' | 'FFD54F' | 'FFB74D' | 'FF8A65' | 'A1887F' | 'E0E0E0' | '90A4AE'

is_openboolean

The ivr is open or not

Example response

{
  "ivr_id": 123456,
  "name": "StandardFacile",
  "color": "ff6b6b",
  "numbers": [
    {
      "number": 33184800000,
      "label": "myfavoritenumber",
      "type": "PHONE",
      "user_id": 60907,
      "ivr_id": 60908,
      "conference_id": 60908,
      "format": {
        "raw": 184800000,
        "country_code": "33",
        "country": "FR",
        "e164": "+33184800000",
        "international": "+33 1 84 80 00 00",
        "international_alt": "33184800000",
        "national": "01 84 80 00 00",
        "national_alt": "0184800000",
        "rfc3966": "tel:+33-1-84-80-00-00"
      }
    }
  ],
  "scenarios": [
    {
      "scenario_id": 123456,
      "ivr_id": 1234,
      "name": "myscenario",
      "color": "123456",
      "scenario_type": "menu",
      "is_default": true
    }
  ],
  "is_open": true
}