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

# Query virtual receptionist server status

`GET /ivr_servers/{id}/status`

## Request

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

Retrieve a virtual receptionist server's status.

## Path parameters

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

## Response `200`

OK

- object
  - `cpu_usage` integer: CPU usage.
  - `memory_usage` integer: Memory usage.
  - `status` 'ONLINE' | 'OFFLINE': Call queue's status: - `ONLINE`: The virtual receptionist server is online. - `OFFLINE`: The virtual receptionist server is offline.

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