IVR

Retrieve moh server

GET /show

Retrieve moh server by it's unique ID.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64
id

integer

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

key3

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
key5

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
key8

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
call_transfer_filename

string
urlactions

object

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

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
id

integer

format : int64
prompt_filename

string
key0

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
key1

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
key9

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
call_transfer_metadata_id

integer

format : int64
language

string

Default Audio prompt file's language.
timeout

object

Show child attributes
- 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']
- timeout
  
  integer
  
  format : uint32
- fwdto_id
  
  integer
  
  format : int64
- extension_number
  
  string
call_transfer_fileid

string
key6

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
name

string

The name of virtual receptionist.
key4

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
key7

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- user_input
  
  string
  
  user_input
- extension_number
  
  string
prompt_metadata_id

integer

format : int64
prompt_fileid

string
failure

object

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  format : int64
- extension_number
  
  string
gap_time

integer

Gap time between DTMF digits.
play_count

integer

format : uint32
extension_number

string

Sample Response

{}

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

integer

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

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

language

string

required

Default Audio prompt file's language.
key3

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key5

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key6

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
prompt_metadata_id

integer

required

format : int64
key4

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
urlactions

object

required

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

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
name

string

required

The name of virtual receptionist.
id

integer

required

format : int64
timeout

object

required

Show child attributes
- 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']
- timeout
  
  integer
  
  required
  
  format : uint32
- fwdto_id
  
  integer
  
  required
  
  format : int64
key7

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key8

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
gap_time

integer

required

Gap time between DTMF digits.
key0

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key9

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
play_count

integer

required

format : uint32
failure

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
key1

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
call_transfer_metadata_id

integer

required

format : int64

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 Response

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

language

string

required

Default Audio prompt file's language.
key3

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key5

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key6

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
prompt_metadata_id

integer

required

format : int64
key4

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
urlactions

object

required

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

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
name

string

required

The name of virtual receptionist.
gap_time

integer

required

Gap time between DTMF digits.
timeout

object

required

Show child attributes
- 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']
- timeout
  
  integer
  
  required
  
  format : uint32
- fwdto_id
  
  integer
  
  required
  
  format : int64
play_count

integer

required

format : uint32
key8

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key0

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key9

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
key7

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
failure

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
key1

object

required

Show child attributes
- 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']
- fwdto_id
  
  integer
  
  required
  
  format : int64
- user_input
  
  string
  
  required
  
  user_input
call_transfer_metadata_id

integer

required

format : int64
extension_number

string

required

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

integer

format : int64

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
count

integer
pagination

integer
virtual_receptionists

array

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

string

Sample Response

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

Sample Request

200

application/json

key3

fwdto_type

fwdto_id

user_input

extension_number

key5

fwdto_type

fwdto_id

user_input

extension_number

key8

fwdto_type

fwdto_id

user_input

extension_number

call_transfer_filename

urlactions

type

caller_mask

callerlist

enabled

dtmf_mask

request_url

request_timeout

name

username

connection_timeout

dtmflist

request_headers

request_method

password

key2

fwdto_type

fwdto_id

user_input

extension_number

id

prompt_filename

key0

fwdto_type

fwdto_id

user_input

extension_number

key1

fwdto_type

fwdto_id

user_input

extension_number

key9

fwdto_type

fwdto_id

user_input

extension_number

call_transfer_metadata_id

language

timeout

fwdto_type

timeout

fwdto_id

extension_number

call_transfer_fileid

key6

fwdto_type

fwdto_id

user_input

extension_number

name

key4

fwdto_type

fwdto_id

user_input

extension_number

key7

fwdto_type

fwdto_id

user_input

extension_number

`200`

`key3`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`key5`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`key8`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`call_transfer_filename`

`urlactions`

`type`

`caller_mask`

`callerlist`

`enabled`

`dtmf_mask`

`request_url`

`request_timeout`

`name`

`username`

`connection_timeout`

`dtmflist`

`request_headers`

`request_method`

`password`

`key2`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`id`

`prompt_filename`

`key0`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`key1`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`key9`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`call_transfer_metadata_id`

`language`

`timeout`

`fwdto_type`

`timeout`

`fwdto_id`

`extension_number`

`call_transfer_fileid`

`key6`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`name`

`key4`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`key7`

`fwdto_type`

`fwdto_id`

`user_input`

`extension_number`

`prompt_metadata_id`

`prompt_fileid`