Virtual Receptionists
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Total number of resource.
100Error
The name of virtual receptionist server.
The activate status or deactivated status.
trueHost IPV4 address.
Host IPV6 address.
OK
Error
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of virtual receptionist server.
The activate status or deactivated status.
trueHost IPV4 address.
Host IPV6 address.
Every PortSIP PBX has a built-in virtual receptionist server marked as INTERNAL;
Newly added virtual receptionist servers will be marked as "EXTERNAL".
Error
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe activate status or deactivated status.
trueOK
No content
Error
No content
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
CPU usage.
Memory usage.
Call queue's status:
ONLINE: The virtual receptionist server is online.OFFLINE: The virtual receptionist server is offline.
Error
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Invalid server id supplied
Server not found
No content
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Total number of resource.
100Error
The name of virtual receptionist.
The extension number.
[0-9]{3,64}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.
en-USThe time to wait for the next DTMF input.
2The unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwWhether the PIN is required for DISA.
trueThe PIN number for accessing.
Whether to enable night mode.
falseThe comma-separated list of extension numbers that cannot be dialed directly.
OK
Error
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of virtual receptionist.
The extension number.
[0-9]{3,64}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.
en-USThe time to wait for the next DTMF input.
2The name of the file.
The file size in bytes.
0The relative path to file url for file downloading.
/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcKThe name of the file.
The file size in bytes.
0The relative path to file url for file downloading.
/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcKWhether the PIN is required for DISA.
trueThe PIN number for accessing.
Whether to enable night mode.
falseThe comma-separated list of extension numbers that cannot be dialed directly.
Error
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of virtual receptionist.
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.
en-USThe time to wait for the next DTMF input.
2The unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwWhether the PIN is required for DISA.
trueThe PIN number for accessing.
Whether to enable night mode.
falseThe comma-separated list of extension numbers that cannot be dialed directly.
OK
No content
Error
No content
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
The status of this virtual receptionists.
OFFLINE:ONLINE:
Error
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Invalid virtual receptionists ID supplied.
No content
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of action url.
Whether to enable or not.
The action url type.
Can be either:
DTMF:CALLER
The action url request method.
Can be either:
GETPOST:
The request headers of action url.
The caller mask of action url.
The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.
The connection timeout in seconds.
2The request timeout in seconds.
2The request url for action url.
The authentication method of action URL:
Can be either:
DISABLE: Disable authentication.BASIC: Use basic authentication.DIGEST: Use digest authentication.BEARER: Use bearer authentication.
DISABLEPossible values: The username for authentication, when auth is BASIC or DIGEST.
[a-z0-9]{6,64}The password for authentication, when auth is BASIC or DIGEST.
[a-z0-9]{6,64}The token for authentication, when auth is BEARER.
OK
Error
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of action url.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
The unique ID of action url.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of action url.
Whether to enable or not.
The action url type.
Can be either:
DTMF:CALLER
The action url request method.
Can be either:
GETPOST:
The request headers of action url.
The caller mask of action url.
The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.
The connection timeout in seconds.
2The request timeout in seconds.
2The request url for action url.
The authentication method of action URL:
Can be either:
DISABLE: Disable authentication.BASIC: Use basic authentication.DIGEST: Use digest authentication.BEARER: Use bearer authentication.
DISABLEPossible values: The username for authentication, when auth is BASIC or DIGEST.
[a-z0-9]{6,64}The password for authentication, when auth is BASIC or DIGEST.
[a-z0-9]{6,64}The token for authentication, when auth is BEARER.
Error
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of action url.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of action url.
Whether to enable or not.
The action url type.
Can be either:
DTMF:CALLER
The action url request method.
Can be either:
GETPOST:
The request headers of action url.
The caller mask of action url.
The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.
The connection timeout in seconds.
2The request timeout in seconds.
2The request url for action url.
The authentication method of action URL:
Can be either:
DISABLE: Disable authentication.BASIC: Use basic authentication.DIGEST: Use digest authentication.BEARER: Use bearer authentication.
DISABLEPossible values: The username for authentication, when auth is BASIC or DIGEST.
[a-z0-9]{6,64}The password for authentication, when auth is BASIC or DIGEST.
[a-z0-9]{6,64}The token for authentication, when auth is BEARER.
OK
No content
Error
No content
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of action url.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Error
No content
Last updated