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.
  • 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.

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
  • pagination

    integer

  • count

    integer

  • sort_by

    string

  • pagesize

    integer

  • virtual_receptionists

    array

    Show child attributes

Sample Response

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

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
  • key0

    object

    required

    Show child attributes
  • key5

    object

    required

    Show child attributes
  • prompt_metadata_id

    integer

    required

  • key3

    object

    required

    Show child attributes
  • timeout

    object

    required

    Show child attributes
  • key2

    object

    required

    Show child attributes
  • key7

    object

    required

    Show child attributes
  • key4

    object

    required

    Show child attributes
  • gap_time

    integer

    required

    Gap time between DTMF digits.
  • name

    string

    required

    The name of virtual receptionist.
  • urlactions

    object

    required

    Show child attributes
  • key6

    object

    required

    Show child attributes
  • key1

    object

    required

    Show child attributes
  • call_transfer_metadata_id

    integer

    required

  • id

    integer

    required

  • language

    string

    required

    Default Audio prompt file's language.
  • failure

    object

    required

    Show child attributes
  • play_count

    integer

    required

  • key9

    object

    required

    Show child attributes
  • key8

    object

    required

    Show child attributes

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

                      
                      
                    

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

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

400
Invalid virtual receptionists ID supplied.
200
Successful operation

Sample Response

                      
                      
                    

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.

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
  • key0

    object

    Show child attributes
  • key5

    object

    Show child attributes
  • timeout

    object

    Show child attributes
  • prompt_filename

    string

  • key2

    object

    Show child attributes
  • key6

    object

    Show child attributes
  • key3

    object

    Show child attributes
  • name

    string

    The name of virtual receptionist.
  • language

    string

    Default Audio prompt file's language.
  • failure

    object

    Show child attributes
  • gap_time

    integer

    Gap time between DTMF digits.
  • call_transfer_filename

    string

  • key8

    object

    Show child attributes
  • prompt_fileid

    string

  • play_count

    integer

  • prompt_metadata_id

    integer

  • key7

    object

    Show child attributes
  • key4

    object

    Show child attributes
  • urlactions

    object

    Show child attributes
  • call_transfer_fileid

    string

  • key1

    object

    Show child attributes
  • call_transfer_metadata_id

    integer

  • id

    integer

  • extension_number

    string

  • key9

    object

    Show child attributes

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
  • key0

    object

    required

    Show child attributes
  • key5

    object

    required

    Show child attributes
  • extension_number

    string

    required

  • prompt_metadata_id

    integer

    required

  • timeout

    object

    required

    Show child attributes
  • key2

    object

    required

    Show child attributes
  • key7

    object

    required

    Show child attributes
  • key4

    object

    required

    Show child attributes
  • gap_time

    integer

    required

    Gap time between DTMF digits.
  • name

    string

    required

    The name of virtual receptionist.
  • urlactions

    object

    required

    Show child attributes
  • key6

    object

    required

    Show child attributes
  • key1

    object

    required

    Show child attributes
  • call_transfer_metadata_id

    integer

    required

  • key3

    object

    required

    Show child attributes
  • language

    string

    required

    Default Audio prompt file's language.
  • failure

    object

    required

    Show child attributes
  • play_count

    integer

    required

  • key9

    object

    required

    Show child attributes
  • key8

    object

    required

    Show child attributes

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

Sample Response

                      
{}