Rate this page:

IVRSettings

IVR menu state settings. Can be passed via the IVRState.settings parameter.
Add the following line to your scenario code to use the interface:

require(Modules.IVR);

Props

inputLength: number

For inputfixed - length of desired input.

inputValidator: (input: string) => boolean

For inputunknown states - whether input is complete (input is passed as string).

nextState: IVRState | null

Next state to go - for noinput state type.

nextStates: {[name: string]: IVRState}

For select type, map of IVR states to go to according to user input. If there is no next state for specific input, onInputComplete is invoked.

prompt: IVRPrompt

Prompt settings object.

terminateOn: string

When this digit is entered in inputunknown mode, input is considered to be complete.

timeout: number

Timeout in milliseconds for user input. The default value is 5000.

type: string

Menu type. Possible values: select, inputfixed, inputunknown, noinput.