Skip to content

Latest commit

 

History

History
 
 

voice-ivr

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
assets
assets
 
 
functions
functions
 
 
tests
tests
 
 
.env
.env
 
 
README.md
README.md
 
 
changelog.md
changelog.md
 
 
package.json
package.json
 
 

README.md

Voice IVR

This application allows users to navigate an IVR (phone tree) using keys or speech-to-text via a Twilio number. When a user calls the number, they are presented with three options: Talk to Sales, Hours of Operation, or Address. Selecting the first option forwards the call to a given phone number. The second provides an immediate voice response with relevant information. Choosing the third option triggers an SMS with the requested details. The application is fully customizable, allowing you to edit the available options and responses.

Pre-requisites

Environment variables

This project requires some environment variables to be set. To keep your tokens and secrets secure, make sure to not commit the .env file in git. When setting up the project with twilio serverless:init ... the Twilio CLI will create a .gitignore file that excludes .env from the version history.

In your .env file, set the following values:

Variable Meaning Required
MY_PHONE_NUMBER The phone number that you want calls to be forwarded to. yes

Function Parameters

/voice-ivr is protected and requires a valid Twilio signature.

/handle-user-input is protected and requires a valid Twilio signature and expects the following parameters:

Parameter Description Required
Digits Automatically provided by Twilio No
SpeechResult Automatically provided by Twilio No
From Automatically provided by Twilio No
To Automatically provided by Twilio No

Create a new project with the template

  1. Install the Twilio CLI
  2. Install the serverless toolkit
twilio plugins:install @twilio-labs/plugin-serverless
  1. Initiate a new project
twilio serverless:init example --template=voice-ivr && cd example
  1. Start the server with the Twilio CLI:
twilio serverless:start
  1. Open the web page at https://localhost:3000/index.html and follow the instructions to test your application.

ℹ️ Check the developer console and terminal for any errors, make sure you've set your environment variables.

Deploying

Deploy your functions and assets with either of the following commands. Note: you must run these commands from inside your project folder. More details in the docs.

With the Twilio CLI:

twilio serverless:deploy