post
https://api.acefone.co.uk/v1/virtual_receptionist
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Using the below method, a virtual receptionist can be created.
curl --request POST \
--url https://api.acefone.co.uk/v1/virtual_receptionist \
--header 'accept: application/json' \
--header 'authorization: Authorization' \
--header 'content-type: application/json'
Body parameter
| Variable Name | Description | Data Type |
|---|---|---|
| name | Name for virtual receptionist | String |
| description | Description for virtual receptionist | String |
| recording | Recording to be played once call is received | Float |
| destination_type | Calls can be directed directly to a single or multiple destination (depending on clients requirement thought DTMF inputs) | String |
| forward_destination_type | Type of destination where call is to be forwarded (required when destination type is single) | String |
| forward_destination_id | Unique ID of destination where call is to be forwarded (required when destination type is single) | Float |
| entries | Allowed DTMF entries associated with virtual receptionist (required when destination_type is multiple) | Object |
| option | DTMF option | Float |
| destination_type | Type of destination where call is to be forwarded (when DTMF option is pressed) | String |
| destination_id | Unique ID of destination where call is to be forwarded (when DTMF option is pressed) | Float |
| template_id | Unique ID of the email template to be associated with DTMF input | Float |
| timeout | Time (in seconds) to wait for each DTMF input (required when destination_type is multiple) | Float |
| incorrect_count | Number of incorrect inputs are allowed (required when destination_type is multiple) | Float |
| invalid_recording | Unique ID of the recording to be played when invalid option is pressed (required when destination_type is multiple) | Float |
| invalid_destination_type | Type of destination where call is to be forwarded when customer has reached maximum number of incorrect inputs allowed (required when destination_type is multiple) | String |
| invalid_destination_id | Unique ID of destination where call is to be forwarded when customer has reached maximum number of incorrect inputs allowed (required when destination_type is multiple) | Float |
| timeout_retries | Number of timeout retried allowed (required when destination_type is multiple) | Float |
| timeout_retry_recording | Unique ID of the recording to be played when timeout has been reached and no input is been recorded from the client (required when destination_type is multiple) | Float |
| timeout_recording | Unique ID of the recording to be played when timeout has been reached and no input is been recorded from the client (required when destination_type is multiple) | Float |
| timeout_destination_type | Type of the destination where call is to be forwarded when maximum number of timeout retries has been reached (required when destination_type is multiple) | String |
| timeout_destination_id | Unique ID of the destination where call is to be forwarded when maximum number of timeout retries has been reached (required when destination_type is multiple) | Float |
| recording_invalid | Unique ID of recording when invalid Input is pressed by client (required when destination_type is multiple) | Float |
| prefix | Caller ID prefix | String |
| intercom | Intercom number | String |
Response
| Variable Name | Description | Data Type |
|---|---|---|
| success | Request success status | Boolean |
| message | Message corresponding success status | String |
500 response