Ivr servers

List virtual receptionist servers

List virtual receptionist servers.

get

/ivr_servers

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ivr_servers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

Create a virtual receptionist server

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

post

/ivr_servers

Authorizations

Body

namestring · min: 1 · max: 64required

The name of virtual receptionist server.

enabledboolean · default: true

The activate status or deactivated status.

ipv4string

Host IPV4 address.

ipv6string

Host IPV6 address.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ivr_servers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","enabled":true}'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve a virtual receptionist server

Retrieve a virtual receptionist server.

get

/ivr_servers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist server.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ivr_servers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

Update a virtual receptionist server

Update a virtual receptionist server.

post

/ivr_servers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist server.

Body

enabledboolean · default: true

The activate status or deactivated status.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ivr_servers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true}'

200

4XX

200

No body

OK