Status

Query virtual receptionist server status

get

Retrieve a virtual receptionist server's status.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of virtual receptionist server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

cpu_usageintegerOptional

CPU usage.

memory_usageintegerOptional

Memory usage.

statusstring · enumOptional

Call queue's status:

• ONLINE: The virtual receptionist server is online.
• OFFLINE: The virtual receptionist server is offline.

Possible values:

4XX

Error

get

/ivr_servers/{id}/status

HTTPcURLJavaScriptPython

GET /api/ivr_servers/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "cpu_usage": 1,
  "memory_usage": 1,
  "status": "ONLINE"
}