v1

latestOpenAPI 3.1.02026-07-241370148.9 KB

Create an IVR

This API allows you to create a new IVR.

post/v1/ivr

Authorizationstring required

namestring required

Name of the IVR.

descriptionstring required

Description of the IVR.

recordingstring required

Unique ID of the recording.

timeoutstring required

Time to wait for user input after recording ends.

optionstring[] required

IVR Options.

destinationstring[] required

Where the call should land corresponding to IVR option.eg: extension||eid, agent's eid eg: 050160000

incorrect_countstring required

Number of retries allowed after invalid inputs.

timeout_recordingstring required

Unique ID of the recording that needs to be played when timeout expires.

invalid_recordingstring required

Unique ID of the recording that needs to be played when an invalid option is pressed.

invalid_destinationstring required

Destination where the call should land when invalid option is selected. eg: extension||eid, agent's eid eg: 050160000

timeout_retry_recordingstring required

Unique ID of the recording that needs to be played when timeout on retry occurs.

timeout_destinationstring required

Destination where the call needs to land when timeout occurs. eg: extension||eid, agent's eid eg: 050160000

sms_templatestring[]

Unique ID of SMS Template to be associated with IVR Option, only applicable if SMS Template setting is enabled for user account.

timeout_triesstring required

The number of times Timeout Retry is allowed

200

object required