Ivrs
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.
100GET /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")
POST /api/ivrs HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1304
{
"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"
},
"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.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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"
},
"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")
POST /api/ivrs/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1278
{
"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"
},
"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