Welcome to Jaxl IVR Simulator.

• What is an IVR?
• Prompt
  • Prompt Strings
  • Prompt Audio
• About Jaxl IVR Simulator
• Try Jaxl IVR Simulator
• Initialize your IVR Project Directory
• Create your First IVR

Press 1 to confirm the transaction,
Press 2 to block the card and talk to our customer representation,
Press 3 to repeat the options

If you have ever experienced a call where the system is asking for your inputs like above, you already understand how an IVR works.

Sentences spoken out by the system are referred to as "Prompt Strings".

During a call, Jaxl IVR Infrastructure convert prompt strings into audio files and playback to the user over the call.

Some examples of prompt string includes:

1. Welcome to My Company.
2. Welcome to Jaxl. Press 1 for customer care. Press 2 for HR department.
3. Thank you for calling us. One of our customer representative will call you back soon. Bye
4. Welcome to Jaxl Payments. Your total amount due is 51 rupee. To make a payment please enter your credit card number followed by star.

Your IVR can also playback custom audio files. Example, playing out a music while the user waits. Such custom audio files are referred to as "Prompt Audios".

A prompt string can also be followed by a prompt audio. Example:

1. Hello. You have reached Jaxl customer support. Please wait while we connect your call. "Prompt Audio playing music".

A prompt audio alone works too. Example:

1. "Prompt audio playing music"

Jaxl IVR Simulator is available as a Docker container. It allows you to quickly build and test your custom IVRs.

In a nutshell, your IVR will be responsible for:

1. Returning "prompt strings" and/or "prompt audios" that will be spoken out to the user
2. Handle user inputs and return prompts in reply to the user

At any point, IVRs can also return prompts followed by hangup to terminate the call.

Lets give it a try by passing -h flag to it:

On Mac & Linux:

docker run \
  -it --rm \
  jaxlinnovationsprivatelimited/jaxl-ivr-simulator -h

On Windows using cmd.exe

docker run ^
  -it --rm ^
  jaxlinnovationsprivatelimited/jaxl-ivr-simulator -h

On Windows using PowerShell

docker run `
  -it --rm `
  jaxlinnovationsprivatelimited/jaxl-ivr-simulator -h

You should see following usage information:

Jaxl IVR Simulator Command Line Interface

positional arguments:
  {init,create,run}
    init             Initialize the IVR project directory
    create           Create a new IVR with the given name
    run              Run an IVR with the given name

options:
  -h, --help         show this help message and exit

1. Create a new directory that will contain your IVR code. For documentation purposes, let's imagine have created a new directory at following path on your system /path/to/ivr/playground/directory

   NOTE: Use a path appropriate for your system.

2. Within your IVR project directory, run the following command:

   On Mac & Linux:

   docker run \
       -it --rm \
       -v ${PWD}:/jaxl/ivr \
       jaxlinnovationsprivatelimited/jaxl-ivr-simulator init

   On Windows using cmd.exe

   docker run ^
       -it --rm ^
       -v %cd%:/jaxl/ivr ^
       jaxlinnovationsprivatelimited/jaxl-ivr-simulator init

   On Windows using PowerShell

   docker run `
       -it --rm `
       -v ${PWD}:/jaxl/ivr `
       jaxlinnovationsprivatelimited/jaxl-ivr-simulator init

init command has initialized your IVR project directory structure as expected by Jaxl IVR Simulator.

To create your first IVR:

1. Open your project directory in VSCode
2. Follow PROJECT.md placed in your project directory for further instructions.