IVR

Destroy virtual receptionists

POST /destroy

Destroy an virtual receptionists entry.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

id

string

required

format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/virtual_receptionists/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

`200`

Successful operation

`400`

Invalid virtual receptionists ID supplied.

Sample Response

Retrieve virtual receptionists

GET /show

Retrieve virtual receptionists server by it's unique ID.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

string

required

The unique ID of virtual receptionists.

format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/virtual_receptionists/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

urlactions

object

Show child attributes
- dtmflist
  
  string
- request_url
  
  string
- type
  
  string
  
  enum : ['DTMF', 'CALLER']
- caller_mask
  
  string
- request_timeout
  
  integer
  
  format : uint32
- request_headers
  
  string
- dtmf_mask
  
  string
- callerlist
  
  string
- request_method
  
  string
  
  enum : ['POST', 'GET']
- enabled
  
  boolean
- password
  
  string
- name
  
  string
- username
  
  string
- connection_timeout
  
  integer
  
  format : uint32
key2

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
key7

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
failure

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
key0

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
call_transfer_fileid

string
key6

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
key3

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
timeout

object

Show child attributes
- timeout
  
  integer
  
  format : uint32
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
prompt_filename

string
key9

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
call_transfer_metadata_id

string

format : int64
key1

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
key8

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
call_transfer_filename

string
id

string

format : int64
prompt_metadata_id

string

format : int64
key4

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
play_count

integer

format : uint32
gap_time

integer

Gap time between DTMF digits.
prompt_fileid

string
name

string

The name of virtual receptionist.
extension_number

string
key5

object

Show child attributes
- extension_number
  
  string
- fwdto_id
  
  string
  
  format : int64
- fwdto_type
  
  string
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  user_input
language

string

Default Audio prompt file's language.

enum : ['zh_CN', 'en_US', 'da_DK', 'de_DE', 'el_GR', 'en_GB', 'es_ES', 'fr_FR', 'it_IT', 'nl_NL', 'pt_PT', 'pt_BR', 'tr_TR']

Sample Response

{}

Retrieve a collection of virtual receptionists

GET /list

Retrieve a collection of virtual receptionists

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
pagination

integer

required

The pagination of paging.

format : int32
pagesize

integer

required

The size of paging.
sort_by

string

optional

Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/virtual_receptionists/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pagesize

integer
sort_by

string
pagination

integer
virtual_receptionists

array

Show child attributes
- name
  
  string
  
  The name of virtual receptionist.
- id
  
  string
  
  format : int64
- extension_number
  
  string
- status
  
  string
  
  enum : ['OFFLINE', 'ONLINE']
count

integer

Sample Response

                      
{
    "pagesize": 10,
    "sort_by": "DEFAULT",
    "pagination": 8,
    "count": 100
}

Create an virtual receptionists entry.

POST /create

Add a new virtual receptionists entry into system.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

call_transfer_metadata_id

string

required

format : int64
urlactions

object

required

Show child attributes
- dtmflist
  
  string
  
  required
- request_url
  
  string
  
  required
- type
  
  string
  
  required
  
  enum : ['DTMF', 'CALLER']
- caller_mask
  
  string
  
  required
- request_timeout
  
  integer
  
  required
  
  format : uint32
- request_headers
  
  string
  
  required
- dtmf_mask
  
  string
  
  required
- callerlist
  
  string
  
  required
- request_method
  
  string
  
  required
  
  enum : ['POST', 'GET']
- enabled
  
  boolean
  
  required
- password
  
  string
  
  required
- name
  
  string
  
  required
- username
  
  string
  
  required
- connection_timeout
  
  integer
  
  required
  
  format : uint32
key1

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key2

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key7

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
language

string

required

Default Audio prompt file's language.

enum : ['zh_CN', 'en_US', 'da_DK', 'de_DE', 'el_GR', 'en_GB', 'es_ES', 'fr_FR', 'it_IT', 'nl_NL', 'pt_PT', 'pt_BR', 'tr_TR']
failure

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
key0

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
prompt_metadata_id

string

required

format : int64
key4

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key6

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key3

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
gap_time

integer

required

Gap time between DTMF digits.
name

string

required

The name of virtual receptionist.
timeout

object

required

Show child attributes
- timeout
  
  integer
  
  required
  
  format : uint32
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
play_count

integer

required

format : uint32
extension_number

string

required
key5

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key9

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key8

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/virtual_receptionists/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

`200`

Created virtual receptionists

application/json

id

string

format : int64

Sample Response

{}

Update virtual receptionists

POST /update

Update virtual receptionists

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

call_transfer_metadata_id

string

required

format : int64
urlactions

object

required

Show child attributes
- dtmflist
  
  string
  
  required
- request_url
  
  string
  
  required
- type
  
  string
  
  required
  
  enum : ['DTMF', 'CALLER']
- caller_mask
  
  string
  
  required
- request_timeout
  
  integer
  
  required
  
  format : uint32
- request_headers
  
  string
  
  required
- dtmf_mask
  
  string
  
  required
- callerlist
  
  string
  
  required
- request_method
  
  string
  
  required
  
  enum : ['POST', 'GET']
- enabled
  
  boolean
  
  required
- password
  
  string
  
  required
- name
  
  string
  
  required
- username
  
  string
  
  required
- connection_timeout
  
  integer
  
  required
  
  format : uint32
key1

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key2

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key7

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
id

string

required

format : int64
failure

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
key0

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
prompt_metadata_id

string

required

format : int64
key4

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key6

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key3

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
gap_time

integer

required

Gap time between DTMF digits.
name

string

required

The name of virtual receptionist.
timeout

object

required

Show child attributes
- timeout
  
  integer
  
  required
  
  format : uint32
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
play_count

integer

required

format : uint32
key9

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
key5

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input
language

string

required

Default Audio prompt file's language.

enum : ['zh_CN', 'en_US', 'da_DK', 'de_DE', 'el_GR', 'en_GB', 'es_ES', 'fr_FR', 'it_IT', 'nl_NL', 'pt_PT', 'pt_BR', 'tr_TR']
key8

object

required

Show child attributes
- fwdto_id
  
  string
  
  required
  
  format : int64
- fwdto_type
  
  string
  
  required
  
  enum : ['END_CALL', 'CONNECT_TO_ANOTHER_EXTENSION', 'CONNECT_TO_RING_GROUP', 'VOICE_MAIL_FOR_EXTENSION', 'CONNECT_TO_CALL_QUEUE', 'REPEAT', 'CONNECT_TO_VIRTUAL_RECEPTIONIST']
- user_input
  
  string
  
  required
  
  user_input

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/virtual_receptionists/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

`200`

Successful operation

Sample Request

200

400

Sample Response

Sample Request

200

application/json

urlactions

dtmflist

request_url

type

caller_mask

request_timeout

request_headers

dtmf_mask

callerlist

request_method

enabled

password

name

username

connection_timeout

key2

extension_number

fwdto_id

fwdto_type

user_input

key7

extension_number

fwdto_id

fwdto_type

user_input

failure

extension_number

fwdto_id

fwdto_type

key0

extension_number

fwdto_id

fwdto_type

user_input

call_transfer_fileid

key6

extension_number

fwdto_id

fwdto_type

user_input

key3

extension_number

fwdto_id

fwdto_type

user_input

timeout

timeout

extension_number

fwdto_id

fwdto_type

prompt_filename

key9

extension_number

fwdto_id

fwdto_type

user_input

call_transfer_metadata_id

key1

extension_number

fwdto_id

fwdto_type

user_input

key8

extension_number

fwdto_id

fwdto_type

user_input

call_transfer_filename

id

prompt_metadata_id

key4

extension_number

fwdto_id

`200`

`400`

`200`

`urlactions`

`dtmflist`

`request_url`

`type`

`caller_mask`

`request_timeout`

`request_headers`

`dtmf_mask`

`callerlist`

`request_method`

`enabled`

`password`

`name`

`username`

`connection_timeout`

`key2`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`key7`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`failure`

`extension_number`

`fwdto_id`

`fwdto_type`

`key0`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`call_transfer_fileid`

`key6`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`key3`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`timeout`

`timeout`

`extension_number`

`fwdto_id`

`fwdto_type`

`prompt_filename`

`key9`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`call_transfer_metadata_id`

`key1`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`key8`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`call_transfer_filename`

`id`

`prompt_metadata_id`

`key4`

`extension_number`

`fwdto_id`

`fwdto_type`

`user_input`

`play_count`

`gap_time`