Virtual Receptionists
Manage your virtual receptionists.
List virtual receptionist servers.
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
Error
GET /api/ivr_servers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"enabled": true,
"type": "INTERNAL",
"ipv4": "text",
"ipv6": "text"
}
]
}Create a virtual receptionist server. Please note that: at least one of ipv4 or ipv6 must be specified.
The name of virtual receptionist server.
The activate status or deactivated status.
trueHost IPV4 address.
Host IPV6 address.
OK
Error
POST /api/ivr_servers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"name": "text",
"enabled": true,
"ipv4": "text",
"ipv6": "text"
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Retrieve a virtual receptionist server.
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
GET /api/ivr_servers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"enabled": true,
"ipv4": "text",
"ipv6": "text",
"type": "INTERNAL"
}Update a virtual receptionist server.
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe activate status or deactivated status.
trueOK
No content
Error
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
Retrieve a virtual receptionist server's status.
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
GET /api/ivr_servers/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"cpu_usage": 1,
"memory_usage": 1,
"status": "ONLINE"
}Delete a virtual receptionist server
The unique ID of virtual receptionist server.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Invalid server id supplied
Server not found
POST /api/ivr_servers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of 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
Error
GET /api/ivrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"extension_number": "text"
}
]
}Add a new virtual receptionist into system.
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.
The PIN policies include:
- A sequence of numbers 6-10 digits in length.
- No repeating numbers (e.g. "111", "222")
- No sequential numbers (e.g. "012", "789")
OK
Error
POST /api/ivrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1377
{
"name": "text",
"extension_number": "text",
"language": "en-US",
"dtmf_interval": 2,
"prompt_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"transfer_prompt_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"enable_pin": true,
"pin": "text",
"timeout_forward_rule": {
"timeout": 30,
"repeat_times": 3,
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"failure_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"night_mode_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"custom_forward_rules": [
{
"user_input": "text",
"office_hours": {
"mode": "CUSTOM",
"monday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"tuesday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"wednesday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"thursday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"friday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"saturday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"sunday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
}
},
"office_hours_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"non_office_hours_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"holidays": [
"NzAwNTUxOTA5NzczMTQ4MTYw"
],
"holiday_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
}
}
],
"outbound_caller_ids": [
{
"provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"caller_id": "text",
"description": "text"
}
]
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Retrieve virtual receptionists server by it's unique ID.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
GET /api/ivrs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"extension_number": "text",
"language": "en-US",
"dtmf_interval": 2,
"prompt_file_name": "text",
"prompt_file_size": 0,
"prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
"transfer_prompt_file_name": "text",
"transfer_prompt_file_size": 0,
"transfer_prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
"enable_pin": true,
"pin": "text",
"timeout_forward_rule": {
"timeout": 30,
"repeat_times": 3,
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"failure_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"night_mode_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"custom_forward_rules": [
{
"user_input": "text",
"office_hours": {
"mode": "CUSTOM",
"monday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"tuesday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"wednesday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"thursday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"friday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"saturday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"sunday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
}
},
"office_hours_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"non_office_hours_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"holidays": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"region": "text",
"consecutive": true,
"every_year": true,
"year_start": 1,
"year_end": 1,
"month_start": 1,
"month_end": 1,
"day_start": 1,
"day_end": 1,
"hour_start": 1,
"hour_end": 1,
"minute_start": 1,
"minute_end": 1
}
],
"holiday_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
}
}
],
"outbound_caller_ids": [
{
"provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"caller_id": "text",
"description": "text"
}
]
}Update a virtual receptionist
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.
The PIN policies include:
- A sequence of numbers 6-10 digits in length.
- No repeating numbers (e.g. "111", "222")
- No sequential numbers (e.g. "012", "789")
OK
No content
Error
POST /api/ivrs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1351
{
"name": "text",
"language": "en-US",
"dtmf_interval": 2,
"prompt_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"transfer_prompt_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"enable_pin": true,
"pin": "text",
"timeout_forward_rule": {
"timeout": 30,
"repeat_times": 3,
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"failure_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"night_mode_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"custom_forward_rules": [
{
"user_input": "text",
"office_hours": {
"mode": "CUSTOM",
"monday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"tuesday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"wednesday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"thursday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"friday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"saturday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
},
"sunday": {
"enabled": true,
"ranges": [
{
"from": "09:00",
"to": "17:00"
}
]
}
},
"office_hours_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"non_office_hours_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
},
"holidays": [
"NzAwNTUxOTA5NzczMTQ4MTYw"
],
"holiday_forward_rule": {
"action": "FORWARD_TO_NUMBER",
"number": "text"
}
}
],
"outbound_caller_ids": [
{
"provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"caller_id": "text",
"description": "text"
}
]
}No content
Query virtual receptionist' status by it's unique ID.
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
GET /api/ivrs/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "OFFLINE"
}Destroy a virtual receptionist.
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Invalid virtual receptionists ID supplied.
POST /api/ivrs/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieves a list of action urls of virtual receptionist.
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
GET /api/ivrs/{id}/action_urls HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"enabled": false,
"type": "DTMF",
"caller_mask": "text",
"dtmf_mask": "text",
"method": "GET",
"headers": "text",
"connection_timeout": 2,
"request_timeout": 2,
"auth": "DISABLE",
"username": "text",
"password": "text",
"token": "text",
"url": "text"
}
]
}Create an action url for virtual receptionist.
The unique ID of virtual receptionist.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Error
POST /api/ivrs/{id}/action_urls HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"name": "text",
"enabled": false,
"type": "DTMF",
"method": "GET",
"headers": "text",
"caller_mask": "text",
"dtmf_mask": "text",
"connection_timeout": 2,
"request_timeout": 2,
"auth": "DISABLE",
"username": "text",
"password": "text",
"token": "text",
"url": "text"
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Retrieve details of action url of virtual receptionist.
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
Error
GET /api/ivrs/{id}/action_urls/{url_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"enabled": false,
"type": "DTMF",
"caller_mask": "text",
"dtmf_mask": "text",
"method": "GET",
"headers": "text",
"connection_timeout": 2,
"request_timeout": 2,
"auth": "DISABLE",
"username": "text",
"password": "text",
"token": "text",
"url": "text"
}Set action url of virtual receptionist.
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
No content
Error
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: 241
{
"name": "text",
"enabled": false,
"type": "DTMF",
"caller_mask": "text",
"dtmf_mask": "text",
"method": "GET",
"headers": "text",
"connection_timeout": 2,
"request_timeout": 2,
"auth": "DISABLE",
"username": "text",
"password": "text",
"token": "text",
"url": "text"
}No content
Destroy an action url from virtual receptionist.
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
POST /api/ivrs/{id}/action_urls/{url_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated