---
title: "List virtual receptionist servers"
method: GET
path: "/ivr_servers"
tags: ["Virtual Receptionist"]
---

# List virtual receptionist servers

`GET /ivr_servers`

## Request

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

List virtual receptionist servers.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` 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.
    - `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".
    - `ipv4` string: Host IPV4 address.
    - `ipv6` string: Host IPV6 address.

## 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)