Ivr servers

List virtual receptionist servers

List virtual receptionist servers.

GEThttp://127.0.0.1:8888/api/ivr_servers

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivr_servers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "enabled": true,
      "type": "INTERNAL",
      "ipv4": "text",
      "ipv6": "text"
    }
  ]
}

Create a virtual receptionist server

Create a virtual receptionist server.
Please note that: at least one of ipv4 or ipv6 must be specified.

POSThttp://127.0.0.1:8888/api/ivr_servers

Body

application/json

name*string

The name of virtual receptionist server.

enabledboolean

The activate status or deactivated status.

ipv4string

Host IPV4 address.

ipv6string

Host IPV6 address.

Response

2014XX

OK

Body

application/json

idall of

The unique ID of virtual receptionist server.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivr_servers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a virtual receptionist server

Retrieve a virtual receptionist server.

GEThttp://127.0.0.1:8888/api/ivr_servers/{id}

Path parameters

id*all of

The unique ID of virtual receptionist server.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of virtual receptionist server.

namestring

The name of virtual receptionist server.

enabledboolean

The activate status or deactivated status.

ipv4string

Host IPV4 address.

ipv6string

Host IPV6 address.

typeenum

Every PortSIP PBX has a built-in virtual receptionist server marked as INTERNAL;
Newly added virtual receptionist servers will be marked as "EXTERNAL".

INTERNALEXTERNAL

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivr_servers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "enabled": true,
  "ipv4": "text",
  "ipv6": "text",
  "type": "INTERNAL"
}

Update a virtual receptionist server

Update a virtual receptionist server.

POSThttp://127.0.0.1:8888/api/ivr_servers/{id}

Path parameters

id*all of

The unique ID of virtual receptionist server.

Body

application/json

enabledboolean

The activate status or deactivated status.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivr_servers/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();