Interactive Voice Response or IVR is an automated telephony system that interacts with human callers through the use of voice and touch-tone keypad selections (DTMF tones).
This application shows how to build an IVR application using Twilio Autopilot. Autopilot is a conversational AI platform to build, train, and deploy artificially intelligent applications that can interact with users over multiple channels.
Implementations in other languages:
| .NET | Java | Python | PHP | Ruby |
|---|---|---|---|---|
| TBD | TBD | TBD | TBD | TBD |
This is a very simple application that provides a setup page where the user can enter all configurable values for the IVR tree. When the setup form is submitted it will run an async script to create all tasks for the IVR workflow in an Autopilot Assistant.
The application also provides a couple of endpoints to handle webhooks and return dynamic tasks for the IVR.
- Node.js web server using Express.js
- User interface to setup IVR responses using Twilio Helper Library.
- Small JSON database using lowdb.
- Unit tests using
mochaandchai - Automated CI testing using GitHub Actions
- One click deploy buttons for Heroku, Glitch and now.sh
This application should give you a ready-made starting point for writing your own IVR application using Autopilot. Before we begin, we need to collect all the config values we need to run the application:
| Config Value | Description |
|---|---|
| Account Sid | Your primary Twilio account identifier - find this in the Console. |
| Auth Token | Used to authenticate - just like the above, you'll find this here. |
| Phone number | A Twilio phone number in E.164 format - you can get one here |
After the above requirements have been met:
-
Clone this repository and
cdinto itgit clone [email protected]:twilio-labs/sample-autopilot-voice-ivr.git cd sample-autopilot-voice-ivr
-
Install dependencies
npm install
-
Set your environment variables
npm run setup
See Twilio Account Settings to locate the necessary environment variables.
-
Run the application
npm start
Alternatively, you can use this command to start the server in development mode. It will reload whenever you change any files.
npm run dev
Your application is now accessible at http://localhost:3000
-
Make the application visible from the outside world.
Your application needs to be accessible in a public internet address for Twilio to be able to connect with it. You can do that in different ways, deploying the app to a public provider or using ngrok to create a tunnel to your local server.
If you have ngrok installed to open a tunnel to you local server run the following command
ngrok http 3000Now your application should be available in a url like:
https://<unique_id>.ngrok.io/ -
Run the autopilot assistant setup
The application provides a setup form that when submitted it will create or update the assistant and its tasks. Go to
/setupin your application, update the configurable fields accordingly, and submit the form to set up the autopilot assistant.That's it! Now you can try the IVR calling your Twilio phone number.
You can run the tests locally by typing:
npm testAdditionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.
Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.
| Service | |
|---|---|
| Heroku |  |
| Glitch |  |
| Zeit |
This tutorial is open source and welcomes contributions. All contributions are subject to our Code of Conduct.
No warranty expressed or implied. Software is as is.