get
https://api-smartflo.tatateleservices.com/v1/ivrs
This API allows you to fetch details of all IVR.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Sample Request
Use the method described below to obtain a detailed list of all IVRs:
curl --request GET \
--url https://api-smartflo.tatateleservices.com/v1/ivrs \
--header 'accept: application/json'📘 Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Sample Response
{
"ivrs": [
{
"id": 7926,
"name": "Welcome IVR",
"description": "Welcome IVR",
"recording": "19549",
"timeout": 30,
"invalid_retries": 1,
"invalid_retry_recording": "244",
"invalid_destination_type": "extension",
"invalid_destination": "050109590001",
"timeout_retry_recording": "245",
"timeout_recording": "245",
"timeout_dest_type": "extension",
"timeout_destination": "050109590001",
"timeout_retries": 1,
"added_by": 10959,
"invalid_recording": 244,
"ivr_menu": [
{
"option": "1",
"destination_type": "ringgroup",
"destination_id": "17839",
"sms_template_id": "0",
"webhook_id": "0"
}
]
},......
]
} Response Variables
| Variable Name | Description | Data Type |
|---|---|---|
| ivrs[n] | List of IVRs. | Array |
| ivrs[n].id | Unique ID of the IVR. For example, 3111. | String |
| ivrs[n].name | Name of the IVR. For example, Election promotion IVR. | String |
| ivrs[n].description | ID of the IVR recording. For example, 8336. | String |
| ivrs[n].timeout | Time for which the IVR will ring. For example, 30. | Number |
| ivrs[n].invalid_retries | Number of invalid retries allowed. For example, 1. | Number |
| ivrs[n].invalid_retry_recording | The unique ID of the recording that will be played during the invalid retry. For example, 8141. | String |
| ivrs[n].invalid_destination_type | Destination where the call will land in case of invalid option being selected. For example, extension. | String |
| ivrs[n].invalid_destination | Unique ID of the destination where the call will land in case of invalid option being selected. For example, 05047530000. | String |
| ivrs[n].timeout_retry_recording | The unique ID of the recording that will be played during the timeout retry. For example, 8185. | String |
| ivrs[n].timeout_recording | Unique ID of recording to be played after Timeout Retry count is more than set value. For example, 8185. | String |
| ivrs[n].timeout_dest_type | Destination where the call will land in case of timeout. For example, extension. | String |
| ivrs[n].timeout_destination | Unique ID of the destination where the call will land in case of timeout. For example, 05047530000. | String |
| ivrs[n].timeout_retries | Number of retries allowed. For example, 1. | Number |
| ivrs[n].added_by | User's unique id. For example, 4753. | Number |
| ivrs[n].invalid_recording | Unique ID of recording to be played when an invalid entry is pressed. For example, 8183. | Number |
| ivrs[n].ivr_menu[n] | Details of IVR menu. | Array |
| ivrs[n].ivr_menu[n].option | DTMF option. For example, 1. | String |
| ivrs[n].ivr_menu[n].destination_type | Destination where the call will land after pressing the IVR menu option. For example, extension. | String |
| ivrs[n].ivr_menu[n].destination_id | Unique ID of destination where the call will land after pressing the IVR menu option. For example, 6992. | String |
| ivrs[n].ivr_menu[n].sms_template_id | Unique ID of the SMS template in IVR menu. For example, 0. | String |
| ivrs[n].ivr_menu[n].webhook_id | Unique ID of the Webhook in IVR menu. For example, 0. | String |