List of IVRs

Interactive voice response (IVR)

Interactive Voice Response (IVR) is an automated telephony system that interacts with callers, gathers information and routes calls to the appropriate recipients.

Servetel 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 IVRs

Detailed List of all broadcasts can be retrieved using the below method

curl --request GET \
  --url https://api.servetel.in/v1/ivrs \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Response variables

Variable Name

Description

Data Type

ivrs

Array of objects containing list of all IVRs

Array

recordings

Array of objects containing list of all recordings

Array

  • ivrs array

Variable Name

Description

Data Type

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].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].invalid_recording

Unique ID of the recording to be played after invalid retry count is more than set value

Integer

ivrs[n].added_by

Unique ID of the user

Integer

  • recordings array

Variable Name

Description

Data Type

recordings[n].id

Unique ID of the recording

Integer

recordings[n].type

Type of recording

String

recordings[n].custom_name

User provided name of recording

String

{
    "ivrs": [
      {
        "id": 1,
        "name": "Test IVR Name",
        "description": "Test IVR Description",
        "timeout": 30,
        "invalid_retries": 1,
        "invalid_retry_recording": "1",
        "invalid_destination_type": "extension",
        "invalid_destination": "0500000000",
        "timeout_retry_recording": "1",
        "timeout_recording": "1",
        "timeout_dest_type": "extension",
        "timeout_destination": "0500000000",
        "timeout_retries": 1,
        "added_by": 1,
        "invalid_recording": 1
      }
    ],
    "recordings": [
      {
        "id": 45,
        "type": "Recording",
        "custom_name": "Recording custom name"
      }
    ]
}