1. References
  2. VoxEngine
  3. IVRState
Rate this page:

IVRState

Represents an IVR menu state.
Add the following line to your scenario code to use the interface:

require(Modules.IVR);

Constructors

constructor

Copy URL

Parameters

  • name:

    string

    State name

  • settings:

    IVRSettings

    IVR menu state settings

  • onInputComplete:

    Function

    Function to call after a user correctly provides input. User input should be passed as an argument

  • onInputTimeout:

    Function

    Function to call in case of input timeout. User input should be passed as an argument

Methods

enter

Copy URL
enter(call: 
Call
): 
void

Starts the IVR from the current state for the specified call

Parameters

  • call:

    Call

    Call that IVR works with

Returns

  • type:

    void

Props

input

Copy URL
input: 
string

This property is set when IVR leaves the specific state and holds user input

settings

Copy URL
settings: 
IVRSettings

IVR state settings object