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
chevron-right
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get
/ivr_servers

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
post
/ivr_servers

Retrieve a virtual receptionist server

get

Retrieve a virtual receptionist server.

Authorizations
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
chevron-right
200

OK

application/json
idall ofOptional

The unique ID of virtual receptionist server.

stringOptional

The unique ID of the resource.

Example: 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:
get
/ivr_servers/{id}

Update a virtual receptionist server

post

Update a virtual receptionist server.

Authorizations
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
Body
enabledbooleanOptional

The activate status or deactivated status.

Default: true
Responses
chevron-right
200

OK

No content

post
/ivr_servers/{id}

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
idall ofRequired

The unique ID of virtual receptionist server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
chevron-right
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:
get
/ivr_servers/{id}/status

Delete a virtual receptionist server

post

Delete a virtual receptionist server

Authorizations
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
post
/ivr_servers/{id}/destroy

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
chevron-right
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get
/ivrs

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_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
transfer_prompt_file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: 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.

Responses
post
/ivrs

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

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
chevron-right
200

OK

application/json
idall ofOptional

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: 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

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

get
/ivrs/{id}

Update a virtual receptionist

post

Update a virtual receptionist

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
namestring · min: 1 · max: 64Optional

The name of virtual receptionist.

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_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
transfer_prompt_file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: 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.

Responses
chevron-right
200

OK

No content

post
/ivrs/{id}

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
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
chevron-right
200

OK

application/json
statusstring · enumRead-onlyOptional

The status of this virtual receptionists.

  • OFFLINE:
  • ONLINE:
Possible values:
get
/ivrs/{id}/status

Delete a virtual receptionist

post

Destroy a virtual receptionist.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
post
/ivrs/{id}/destroy

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
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
chevron-right
200

OK

application/json
get
/ivrs/{id}/action_urls

Create an action url

post

Create an action url for virtual receptionist.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: 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 · min: 6 · max: 64Optional

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

Pattern: [a-z0-9]{6,64}
passwordstring · min: 6 · max: 64Optional

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

Pattern: [a-z0-9]{6,64}
tokenstringOptional

The token for authentication, when auth is BEARER.

Responses
post
/ivrs/{id}/action_urls

Retrieve action url

get

Retrieve details of action url of virtual receptionist.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
url_idall ofRequired

The unique ID of action url.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
chevron-right
200

OK

application/json
idall ofOptional

The unique ID of action url.

stringOptional

The unique ID of the resource.

Example: 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 · min: 6 · max: 64Optional

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

Pattern: [a-z0-9]{6,64}
passwordstring · min: 6 · max: 64Optional

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

Pattern: [a-z0-9]{6,64}
tokenstringOptional

The token for authentication, when auth is BEARER.

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

Update action url

post

Set action url of virtual receptionist.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
url_idall ofRequired

The unique ID of action url.

stringOptional

The unique ID of the resource.

Example: 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 · min: 6 · max: 64Optional

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

Pattern: [a-z0-9]{6,64}
passwordstring · min: 6 · max: 64Optional

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

Pattern: [a-z0-9]{6,64}
tokenstringOptional

The token for authentication, when auth is BEARER.

Responses
chevron-right
200

OK

No content

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

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
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
url_idall ofRequired

The unique ID of action url.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
post
/ivrs/{id}/action_urls/{url_id}/destroy

No content

Last updated