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

# Retrieve a virtual receptionist server

`GET /ivr_servers/{id}`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/ivr_servers/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/ivr_servers/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a virtual receptionist server.

## 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 server.
  - `enabled` boolean: The activate status or deactivated status.
  - `ipv4` string: Host IPV4 address.
  - `ipv6` string: Host IPV6 address.
  - `type` 'INTERNAL' | 'EXTERNAL': Every PortSIP PBX has a built-in virtual receptionist server marked as `INTERNAL`; Newly added virtual receptionist servers will be marked as "EXTERNAL".

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)