Sample Request

curl --request GET \
     --url https://api-account-uk.acefone.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

The response returned is as following:

Variable Name	Description	Data Type
ivrs	Array of objects containing list of all IVRs.	Array
ivrs[n].id	Unique ID of the IVR	Integer
ivrs[n].name	Name for the IVR	String
ivrs[n].description	Description for the IVR	String
ivrs[n].recording	Unique ID of the welcome recording for the IVR.	String
ivrs[n].timeout	Time for which the IVR will ring.	Integer
ivrs[n].invalid_retries	The number of times an invalid DTMF input is allowed.	Integer
ivrs[n].invalid_retry_recording	Recording to be played when an invalid DTMF input is pressed.	String
ivrs[n].invalid_destination_type	Type of destination where call lands If number of invalid retries reaches more than the value set.	String
ivrs[n].invalid_destination	Unique ID of destination where call lands If number of invalid retries reaches more than the value set.	String
ivrs[n].timeout_retry_recording	Unique ID of the recording to be played when timeout entry is added	String
ivrs[n].timeout_recording	Unique ID of the recording to be played after timeout retry count is more than set value	String
ivrs[n].timeout_dest_type	Type of the destination where call is routed If number of timeout retries reaches more than the value set	String
ivrs[n].timeout_destination	Unique ID of the destination where call is routed If number of timeout retries reaches more than the value set	String
ivrs[n].timeout_retries	The number of times timeout retry is allowed.	Integer
ivrs[n].added_by	Unique ID of the user.	Integer
ivrs[n].invalid_recording	Unique ID of the recording to be played after invalid retry count is more than set value.	Integer
ivr[n].ivr_menu.option	Number of the DTMF input.	Integer
ivr[n].ivr_menu.destination_type	Type of the destination where call is routed If the DTMF input is selected.	String
ivr[n].ivr_menu.destination_id	Unique ID of the destination where call is routed.	String
ivr[n].ivr_menu.sms_template_id	Unique ID of the sms template corresponding to the DTMF input.	String
ivr[n].ivr_menu.webhook_id	Unique ID of the webhook corresponding to the DTMF input.	String