Virtual Receptionists

Manage your virtual receptionists.

List virtual receptionist servers

get

List virtual receptionist servers.

Authorizations
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
OK
application/json
get
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

post

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

Authorizations
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
OK
application/json
post
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

get

Retrieve a virtual receptionist server.

Authorizations
Path parameters
idall ofRequired

The unique ID of virtual receptionist server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
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

post

Update a virtual receptionist server.

Authorizations
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
200
OK
post
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
Path parameters
idall ofRequired

The unique ID of virtual receptionist server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
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

post

Delete a virtual receptionist server

Authorizations
Path parameters
idall ofRequired

The unique ID of virtual receptionist server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
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
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
OK
application/json
get
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"
    }
  ]
}

Create a virtual receptionist.

post

Add a new virtual receptionist into system.

Authorizations
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
pinstring · min: 6 · max: 10Required

The PIN number for accessing.
The PIN policies include:

  1. A sequence of numbers 6-10 digits in length.
  2. No repeating numbers (e.g. "111", "222")
  3. No sequential numbers (e.g. "012", "789")
Responses
201
OK
application/json
post
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 a virtual receptionist

get

Retrieve virtual receptionists server by it's unique ID.

Authorizations
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
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

post

Update a virtual receptionist

Authorizations
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
pinstring · min: 6 · max: 10Optional

The PIN number for accessing.
The PIN policies include:

  1. A sequence of numbers 6-10 digits in length.
  2. No repeating numbers (e.g. "111", "222")
  3. No sequential numbers (e.g. "012", "789")
Responses
200
OK
post
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's status

get

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

Authorizations
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/ivrs/{id}/status HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "status": "OFFLINE"
}

Delete a virtual receptionist

post

Destroy a virtual receptionist.

Authorizations
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
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
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
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

post

Create an action url for virtual receptionist.

Authorizations
Path parameters
idall ofRequired

The unique ID of virtual receptionist.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
all ofOptional
Responses
201
OK
application/json
post
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 action url

get

Retrieve details of action url of virtual receptionist.

Authorizations
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
200
OK
application/json
Responseall of
get
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"
}

Update action url

post

Set action url of virtual receptionist.

Authorizations
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
all ofOptional
Responses
200
OK
post
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

Delete an action url

post

Destroy an action url from virtual receptionist.

Authorizations
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
204
No Content
post
POST /api/ivrs/{id}/action_urls/{url_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content