get https://api.acefone.co.uk/v1/virtual_receptionists
A virtual receptionist is an automated telephony system that interacts with callers, gathers information, and routes call to the appropriate recipients.
Acefone offers an IVRS ( IVR System ) that accepts touch-tone keypad input and provides the appropriate response by routing the call to the desired location of the input as assigned by the user.
Below are the details of the IVRS APIs offered.
Get List of all virtual receptionist
Using the below method, a detailed list of all broadcasts can be retrieved.
curl --request GET \
--url https://api.acefone.co.uk/v1/virtual_receptionists \
--header 'accept: application/json' \
--header 'authorization: Authorization'
Response
| Variable Name | Description | Data Type |
|---|---|---|
| id | Unique ID of the virtual receptionist | Number |
| name | Name of virtual receptionist | String |
| description | Description of virtual receptionist | String |
| recording | Unique ID of the recording to be played when call is received | Number |
| timeout | Time (in seconds) to wait for DTMF options to be pressed by users | Number |
| prefix | Caller ID prefix | String |
| invalid_retries | Number of invalid retries allowed | Number |
| invalid_retry_recording | Unique ID of the recording to be played (when invalid DTMF option is pressed) | Number |
| invalid_destination_type | Type of destination where call is to be forwarded (when number of valid entries is reached) | String |
| invalid_destination | Unique ID of destination where call is to be forwarded (when number of valid entries is reached) | Number |
| timeout_retry_recording | Unique ID of recording to be played on retry timeout | Number |
| timeout_recording | Unique ID of recording to be played on timeout | Number |
| timeout_destination_type | Type of destination where call is to be forwarded (when no DTMF options is pressed before set timeout seconds) | String |
| timeout_destination | Unique ID of destination where call is to be forwarded (when no DTMF options is pressed before set timeout seconds) | Number |
| timeout_retries | Number of timeout retries allowed | Number |
| intercom | Intercom set for virtual receptionist | String |
| invalid_recording | Unique ID of recording to be played (when invalid option is pressed) | Number |
| forward_destination | Type of destination where call is to be forwarded (not null in case of single destination) | String |
| forward_destination_type | Unique ID of destination where call is to be forwarded (not null in case of single destination) | String |