---
title: "Retrieve a virtual receptionist"
method: GET
path: "/ivrs/{id}"
tags: ["Virtual Receptionist"]
---

# Retrieve a virtual receptionist

`GET /ivrs/{id}`

Retrieve virtual receptionists server by it's unique ID.

## Path parameters

- `id` string, required — The unique ID of the resource.

## Response `200`

OK

- object
  - `id` string — The unique ID of the resource.
  - `name` string — The name of virtual receptionist.
  - `extension_number` string — The extension number.
  - `language` string — 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_interval` integer — The time to wait for the next DTMF input.
  - `prompt_file_name` string — The name of the file.
  - `prompt_file_size` integer — The file size in bytes.
  - `prompt_file_url` string — The relative path to file url for file downloading.
  - `transfer_prompt_file_name` string — The name of the file.
  - `transfer_prompt_file_size` integer — The file size in bytes.
  - `transfer_prompt_file_url` string — The relative path to file url for file downloading.
  - `enable_pin` boolean — Whether the PIN is required for DISA.
  - `pin` string — 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")
  - `timeout_forward_rule` object
    - `timeout` integer — Single call timeout
    - `repeat_times` integer — When timeout, the number of times to repeat the prompt tone
    - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'REPEAT' | 'HANGUP' — Forward actions includes: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `REPEAT`: - `HANGUP`:
    - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning.
  - `failure_forward_rule` object
    - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'REPEAT' | 'HANGUP' — Forward actions includes: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `REPEAT`: - `HANGUP`:
    - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning.
  - `custom_forward_rules` object[]
    - `user_input` string — User input.
    - `office_hours` object
      - `mode` 'GLOBAL' | 'CUSTOM' — The office hours mode can be either: - `GLOBAL`: Use global office hours. - `CUSTOM`: Use specific office hours.
      - `monday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
      - `tuesday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
      - `wednesday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
      - `thursday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
      - `friday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
      - `saturday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
      - `sunday` object
        - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time.
        - `ranges` object[] — Multiple start and end time periods make up the working time.
          - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`.
          - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`.
    - `office_hours_forward_rule` object
      - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'REPEAT' | 'HANGUP' | 'DISA' — Forward rule actions for DTMF: Can be either: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `REPEAT`: - `HANGUP`: - `DISA`:
      - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning.
    - `non_office_hours_forward_rule` object
      - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'REPEAT' | 'HANGUP' | 'DISA' — Forward rule actions for DTMF: Can be either: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `REPEAT`: - `HANGUP`: - `DISA`:
      - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning.
    - `holidays` object[]
      - `id` string — The unique ID of the resource.
      - `name` string — The name of the holiday.
      - `region` string — A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
      - `consecutive` boolean — Whether the holiday consists of consecutive days.
      - `every_year` boolean — Does the holiday take effect every year.
      - `year_start` integer — The start year of holiday.
      - `year_end` integer — The end year of holiday.
      - `month_start` integer — The start month of holiday.
      - `month_end` integer — The end month of holiday.
      - `day_start` integer — The start day of holiday.
      - `day_end` integer — The end day of holiday.
      - `hour_start` integer — The start hour of holiday.
      - `hour_end` integer — The end hour of holiday.
      - `minute_start` integer — The start minute of holiday.
      - `minute_end` integer — The end minute of holiday.
    - `holiday_forward_rule` object
      - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'REPEAT' | 'HANGUP' | 'DISA' — Forward rule actions for DTMF: Can be either: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `REPEAT`: - `HANGUP`: - `DISA`:
      - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning.
  - `outbound_caller_ids` object[] — A collection of outbound caller IDs.
    - `provider_id` string — The unique ID of the resource.
    - `caller_id` string — Outbound caller id.
    - `description` string — The descriptive information about this outbound caller id.

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)