Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Virtual Receptionist

Retrieve a virtual receptionist

Retrieve virtual receptionists server by it's unique ID.

get/ivrs/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the virtual receptionist.

Response

OK

idstring

The unique ID of the resource.

namestring

The name of virtual receptionist.

extension_numberstring

The extension number.

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

dtmf_intervalinteger

The time to wait for the next DTMF input.

prompt_file_namestring

The name of the file.

prompt_file_sizeinteger

The file size in bytes.

prompt_file_urlstring

The relative path to file url for file downloading.

transfer_prompt_file_namestring

The name of the file.

transfer_prompt_file_sizeinteger

The file size in bytes.

transfer_prompt_file_urlstring

The relative path to file url for file downloading.

enable_pinboolean

Whether the PIN is required for DISA.

pinstring

The PIN number for accessing.
The PIN policies include:

  1. A sequence of numbers 6-10 digits in length.
  2. No repeating numbers (e.g. "111", "222")
  3. No sequential numbers (e.g. "012", "789")

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "language": "en-US",
  "prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "transfer_prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "custom_forward_rules": [
    {
      "office_hours": {
        "mode": "CUSTOM",
        "monday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        }
      },
      "holidays": [
        {
          "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
        }
      ]
    }
  ],
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}