v1

latestOpenAPI 3.1.02026-07-241360148.9 KB

Create IVR

This API allows you to create a new IVR.

post/v1/ivr

Authorizationstring required

Bearer token

namestring required

Name of the IVR

descriptionstring required

Description for IVR

recordingstring required

Unique ID of the recording. For example, recording||28935. ID can be retrieved through the system recordings on the web panel

timeoutinteger required

Time for which the IVR will ring. For example, 30

transfer codestring

destinationstring[] required

For example, extension||id

optioninteger[] required

DTMF option, you can add more options by clicking on ADD button. For example, 1

incorrect_countinteger required

The number of retries permitted after invalid inputs. For example, 2.

invalid_recordingstring required

For example, recording||id

invalid_destinationstring required

For example, extension||id

timeout_retry_recordingstring required

For example, recording||id

timeout_recordingstring required

For example, recording||id

timeout_destinationstring required

For example, extension||id

timeout_triesinteger required

For example, 2

recording_invalidstring required

For example, recording||id

timeout_retriesinteger required

For example, 2.

sms templateinteger[]

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

200

object required