put https://api-smartflo.tatateleservices.com/v1/ivr/id
This API allows you to update the details of particular IVR.
Sample Request
Use the following API method to update an IVR:
curl --request PUT \
--url https://api-smartflo.tatateleservices.com/v1/ivr/id \
--header 'accept: application/json' \
--header 'content-type: application/json'
📘Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Request Variables (Path Params)
| Variable Name | Description | Data Type |
|---|---|---|
| id* | The unique ID of the IVR. For example, 349. Note: Get the ID from Fetch List of IVR API Reference. | String |
Request Variables (Body Params)
The details fetched using API are as following:
| Variable Name | Description | Data Type |
|---|---|---|
| name* | The name of the IVR. For example, Support IVR. | String |
| description* | The description of IVR. For example, IVR for the support team. | String |
| recording* | The unique ID of the recording. For example, recording|0231. | String |
| timeout* | The time for which the IVR will ring. For example, 20. | Integer |
| incorrect_count* | The number of times an invalid entry is allowed. For example, 5. | Integer |
| invalid_recording* | The recording to be played when an invalid entry is pressed. For example, recording|349. | String |
| invalid_destination* | The invalid destination after invalid retries reaches more than the value set. For example, extension|05047530002. | String |
| timeout_retry_recording* | The recording to be played when timeout entry is added. For example, recording|52156. | String |
| timeout_recording* | The recording to be played after timeout retry count is more than set value. For example, recording|123. | String |
| timeout_destination* | The number of timeout retries reaches more than the set value then redirect to timeout destination. For example, extension|05047530002. | String |
| timeout_tries* | The number of times timeout retry is allowed. For example, 3. | Integer |
| recording_invalid* | The recording to be played after invalid retry count is more than set value. For example, recording|58999. | String |
| option* | The destination options added for an IVR menu. Note: Create multiple DTMF options using Add button. For example, 1,2,3,4. | Array of Strings |
| destination* | The options allowed for call destination. For example, extension|05047530002, extension|845. | Array of Strings |
Response Variables
The response returned is as following:
| Variable Name | Description | Data Type |
|---|---|---|
| Success | The request success status, the possible values are: True (default) for success. False for failure. | Boolean |
| Message | The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here. | String |