Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Virtual Receptionist

Retrieve a virtual receptionist server

Retrieve a virtual receptionist server.

get/ivr_servers/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

Response

OK

idstring

The unique ID of the resource.

namestring

The name of virtual receptionist server.

enabledboolean

The activate status or deactivated status.

ipv4string

Host IPV4 address.

ipv6string

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".

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}