Virtual Receptionists

Manage your virtual receptionists.

List virtual receptionist servers

get

List virtual receptionist servers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0

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

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

Default: 100

Responses

200

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/ivr_servers

GET /api/ivr_servers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "enabled": true,
      "type": "INTERNAL",
      "ipv4": "127.0.0.1",
      "ipv6": "2001:0db8:0a0b:12f0::1"
    }
  ]
}

Create a virtual receptionist server

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

The name of virtual receptionist server.

enabledbooleanOptional

The activate status or deactivated status.

Default: true

ipv4stringOptional

Host IPV4 address.

ipv6stringOptional

Host IPV6 address.

Responses

201

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/ivr_servers

POST /api/ivr_servers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "example",
  "enabled": true,
  "ipv4": "127.0.0.1",
  "ipv6": "2001:0db8:0a0b:12f0::1"
}

{
  "id": "xxxxxxxx"
}

Retrieve a virtual receptionist server

get

Retrieve a virtual receptionist server.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of virtual receptionist server.

enabledbooleanOptional

The activate status or deactivated status.

Default: true

ipv4stringOptional

Host IPV4 address.

ipv6stringOptional

Host IPV6 address.

typestring · enumRead-onlyOptional

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

Possible values:

4XX

Error

get/ivr_servers/{id}

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

{
  "id": "xxxxxx",
  "name": "example",
  "enabled": true,
  "ipv4": "127.0.0.1",
  "ipv6": "2001:0db8:0a0b:12f0::1",
  "type": "INTERNAL"
}

Update a virtual receptionist server

post

Update a virtual receptionist server.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

enabledbooleanOptional

The activate status or deactivated status.

Default: true

Responses

200

No content

4XX

Error

post/ivr_servers/{id}

POST /api/ivr_servers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

No content

Query virtual receptionist server status

get

Retrieve a virtual receptionist server's status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

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

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

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

Delete a virtual receptionist server

post

Delete a virtual receptionist server

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

400

Invalid server id supplied

404

Server not found

post/ivr_servers/{id}/destroy

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

No content

Lists virtual receptionists

get

Retrieve a collection of virtual receptionists.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0

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

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

Default: 100

Responses

200

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/ivrs

GET /api/ivrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "extension_number": "101"
    }
  ]
}

Create a virtual receptionist.

post

Add a new virtual receptionist into system.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

The name of virtual receptionist.

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

languagestringOptional

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: en-US

dtmf_intervalinteger · int32 · min: 1Optional

The time to wait for the next DTMF input.

Default: 2

prompt_file_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

transfer_prompt_file_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

enable_pinbooleanOptional

Whether the PIN is required for DISA.

Default: true

pinstringRequired

The PIN number for accessing.

enable_night_modebooleanOptional

Whether to enable night mode.

Default: false

exclude_liststringOptional

The comma-separated list of extension numbers that cannot be dialed directly.

enable_audio_recordingbooleanOptional

Whether to enable audio recording.

Default: false

Responses

201

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/ivrs

POST /api/ivrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 514

{
  "name": "example",
  "extension_number": "101",
  "language": "en-US",
  "dtmf_interval": 2,
  "prompt_file_id": "xxxxxx",
  "transfer_prompt_file_id": "xxxxxx",
  "enable_pin": true,
  "pin": "",
  "enable_night_mode": true,
  "exclude_list": "",
  "timeout_forward_rule": {
    "action": "HANGUP"
  },
  "failure_forward_rule": {
    "action": "HANGUP"
  },
  "night_mode_forward_rule": {
    "action": "HANGUP"
  },
  "custom_forward_rules": [],
  "outbound_caller_ids": [
    {
      "provider_id": "xxxxxx",
      "caller_id": "1000",
      "description": "example",
      "display_name": "1000"
    }
  ],
  "enable_audio_recording": false
}

{
  "id": "xxxxxxxx"
}

Retrieve a virtual receptionist

get

Retrieve virtual receptionists server by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the virtual receptionist.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of virtual receptionist.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

languagestringOptional

Example: en-US

dtmf_intervalinteger · int32 · min: 1Optional

The time to wait for the next DTMF input.

Default: 2

prompt_file_namestringOptional

The name of the file.

prompt_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

prompt_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

transfer_prompt_file_namestringOptional

The name of the file.

transfer_prompt_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

transfer_prompt_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

enable_pinbooleanOptional

Whether the PIN is required for DISA.

Default: true

pinstringOptional

The PIN number for accessing.

enable_night_modebooleanOptional

Whether to enable night mode.

Default: false

exclude_liststringOptional

The comma-separated list of extension numbers that cannot be dialed directly.

enable_audio_recordingbooleanOptional

Whether to enable audio recording.

Default: false

4XX

Error

get/ivrs/{id}

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

{
  "id": "xxxxxx",
  "name": "example",
  "extension_number": "101",
  "language": "en-US",
  "dtmf_interval": 2,
  "prompt_file_name": "example",
  "prompt_file_size": 100,
  "prompt_file_url": "",
  "transfer_prompt_file_name": "example",
  "transfer_prompt_file_size": 100,
  "transfer_prompt_file_url": "",
  "enable_pin": true,
  "pin": "",
  "enable_night_mode": true,
  "exclude_list": "",
  "timeout_forward_rule": {
    "action": "HANGUP"
  },
  "failure_forward_rule": {
    "action": "HANGUP"
  },
  "night_mode_forward_rule": {
    "action": "HANGUP"
  },
  "custom_forward_rules": [],
  "outbound_caller_ids": [
    {
      "provider_id": "xxxxxx",
      "caller_id": "1000",
      "description": "example",
      "display_name": "1000"
    }
  ],
  "enable_audio_recording": false
}

Update a virtual receptionist

post

Update a virtual receptionist

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of virtual receptionist.

languagestringOptional

Example: en-US

dtmf_intervalinteger · int32 · min: 1Optional

The time to wait for the next DTMF input.

Default: 2

prompt_file_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

transfer_prompt_file_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

enable_pinbooleanOptional

Whether the PIN is required for DISA.

Default: true

pinstringOptional

The PIN number for accessing.

enable_night_modebooleanOptional

Whether to enable night mode.

Default: false

exclude_liststringOptional

The comma-separated list of extension numbers that cannot be dialed directly.

enable_audio_recordingbooleanOptional

Whether to enable audio recording.

Default: false

Responses

200

No content

4XX

Error

post/ivrs/{id}

POST /api/ivrs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "name": "example",
  "language": "en-US",
  "dtmf_interval": 2,
  "prompt_file_id": "xxxxxx",
  "transfer_prompt_file_id": "xxxxxx",
  "enable_pin": true,
  "pin": "",
  "enable_night_mode": true,
  "exclude_list": "",
  "timeout_forward_rule": {
    "action": "HANGUP"
  },
  "failure_forward_rule": {
    "action": "HANGUP"
  },
  "night_mode_forward_rule": {
    "action": "HANGUP"
  },
  "custom_forward_rules": [],
  "outbound_caller_ids": [
    {
      "provider_id": "xxxxxx",
      "caller_id": "1000",
      "description": "example",
      "display_name": "1000"
    }
  ],
  "enable_audio_recording": false
}

No content

Query virtual receptionist's status

get

Query virtual receptionist' status by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

statusstring · enumRead-onlyOptional

The status of this virtual receptionists.

OFFLINE:
ONLINE:

Possible values:

4XX

Error

get/ivrs/{id}/status

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

{
  "status": "ONLINE"
}

Delete a virtual receptionist

post

Destroy a virtual receptionist.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

400

Invalid virtual receptionists ID supplied.

post/ivrs/{id}/destroy

POST /api/ivrs/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List action urls

get

Retrieves a list of action urls of virtual receptionist.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

4XX

Error

get/ivrs/{id}/action_urls

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

{
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "enabled": true,
      "type": "DTMF",
      "method": "GET",
      "headers": "",
      "caller_mask": "",
      "dtmf_mask": "",
      "connection_timeout": 3,
      "request_timeout": 3,
      "url": "https://example.com",
      "auth": "BASIC",
      "username": "username",
      "password": "xxxxxx",
      "token": ""
    }
  ]
}

Create an action url

post

Create an action url for virtual receptionist.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of action url.

enabledbooleanOptional

Whether to enable or not.

typestring · enumOptional

The action url type.
Can be either:

DTMF:
CALLER

Possible values:

methodstring · enumOptional

The action url request method.
Can be either:

GET
POST:

Possible values:

headersstringOptional

The request headers of action url.

caller_maskstring · max: 255Optional

The caller mask of action url.

dtmf_maskstring · max: 255Optional

The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.

connection_timeoutinteger · int32Optional

The connection timeout in seconds.

Default: 2

request_timeoutinteger · int32Optional

The request timeout in seconds.

Default: 2

urlstring · min: 1 · max: 1024Optional

The request url for action url.

authstring · enumOptional

The authentication method of action URL:
Can be either:

DISABLE: Disable authentication.
BASIC: Use basic authentication.
DIGEST: Use digest authentication.
BEARER: Use bearer authentication.

Default: DISABLEPossible values:

usernamestring · max: 64Optional

The username for authentication, when auth is BASIC or DIGEST.

passwordstring · max: 64Optional

The password for authentication, when auth is BASIC or DIGEST.

tokenstringOptional

The token for authentication, when auth is BEARER.

Responses

201

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/ivrs/{id}/action_urls

POST /api/ivrs/{id}/action_urls HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "name": "example",
  "enabled": true,
  "type": "DTMF",
  "method": "GET",
  "headers": "",
  "caller_mask": "",
  "dtmf_mask": "",
  "connection_timeout": 3,
  "request_timeout": 3,
  "url": "https://example.com",
  "auth": "BASIC",
  "username": "user",
  "password": "xxxxxx",
  "token": ""
}

{
  "id": "xxxxxxxx"
}

Retrieve action url

get

Retrieve details of action url of virtual receptionist.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

url_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of action url.

enabledbooleanOptional

Whether to enable or not.

typestring · enumOptional

The action url type.
Can be either:

DTMF:
CALLER

Possible values:

methodstring · enumOptional

The action url request method.
Can be either:

GET
POST:

Possible values:

headersstringOptional

The request headers of action url.

caller_maskstring · max: 255Optional

The caller mask of action url.

dtmf_maskstring · max: 255Optional

The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.

connection_timeoutinteger · int32Optional

The connection timeout in seconds.

Default: 2

request_timeoutinteger · int32Optional

The request timeout in seconds.

Default: 2

urlstring · min: 1 · max: 1024Optional

The request url for action url.

authstring · enumOptional

The authentication method of action URL:
Can be either:

DISABLE: Disable authentication.
BASIC: Use basic authentication.
DIGEST: Use digest authentication.
BEARER: Use bearer authentication.

Default: DISABLEPossible values:

usernamestring · max: 64Optional

The username for authentication, when auth is BASIC or DIGEST.

passwordstring · max: 64Optional

The password for authentication, when auth is BASIC or DIGEST.

tokenstringOptional

The token for authentication, when auth is BEARER.

4XX

Error

get/ivrs/{id}/action_urls/{url_id}

GET /api/ivrs/{id}/action_urls/{url_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "name": "example",
  "enabled": true,
  "type": "DTMF",
  "method": "GET",
  "headers": "",
  "caller_mask": "",
  "dtmf_mask": "",
  "connection_timeout": 3,
  "request_timeout": 3,
  "url": "https://example.com",
  "auth": "BASIC",
  "username": "user",
  "password": "xxxxxx",
  "token": ""
}

Update action url

post

Set action url of virtual receptionist.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

url_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of action url.

enabledbooleanOptional

Whether to enable or not.

typestring · enumOptional

The action url type.
Can be either:

DTMF:
CALLER

Possible values:

methodstring · enumOptional

The action url request method.
Can be either:

GET
POST:

Possible values:

headersstringOptional

The request headers of action url.

caller_maskstring · max: 255Optional

The caller mask of action url.

dtmf_maskstring · max: 255Optional

The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.

connection_timeoutinteger · int32Optional

The connection timeout in seconds.

Default: 2

request_timeoutinteger · int32Optional

The request timeout in seconds.

Default: 2

urlstring · min: 1 · max: 1024Optional

The request url for action url.

authstring · enumOptional

The authentication method of action URL:
Can be either:

DISABLE: Disable authentication.
BASIC: Use basic authentication.
DIGEST: Use digest authentication.
BEARER: Use bearer authentication.

Default: DISABLEPossible values:

usernamestring · max: 64Optional

The username for authentication, when auth is BASIC or DIGEST.

passwordstring · max: 64Optional

The password for authentication, when auth is BASIC or DIGEST.

tokenstringOptional

The token for authentication, when auth is BEARER.

Responses

200

No content

4XX

Error

post/ivrs/{id}/action_urls/{url_id}

POST /api/ivrs/{id}/action_urls/{url_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "name": "example",
  "enabled": true,
  "type": "DTMF",
  "method": "GET",
  "headers": "",
  "caller_mask": "",
  "dtmf_mask": "",
  "connection_timeout": 3,
  "request_timeout": 3,
  "url": "https://example.com",
  "auth": "BASIC",
  "username": "user",
  "password": "xxxxxx",
  "token": ""
}

No content

Delete an action url

post

Destroy an action url from virtual receptionist.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

url_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

4XX

Error

post/ivrs/{id}/action_urls/{url_id}/destroy

POST /api/ivrs/{id}/action_urls/{url_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousOutbound rules NextMedia Server

Last updated 20 days ago

Was this helpful?