This repository is now archived and is no longer being maintained. Check out the JavaScript SDK Quickstarts to get started with browser-based calling.
Learn how to use Twilio's JavaScript SDK to make browser-to-phone and browser-to-browser calls with ease. The unsatisfied customers of the Birchwood Bicycle Polo Co. need your help!
This application should give you a ready-made starting point for writing your own application. Before we begin, we need to collect all the config values we need to run the application:
| Config Value | Description |
|---|---|
| TWILIO_ACCOUNT_SID | Your primary Twilio account identifier - find this in the Console. |
| TWILIO_NUMBER | A Twilio phone number in E.164 format - you can get one here |
| TWILIO_APP_SID | The TwiML application with a voice URL configured to access your server running this app - create one in the console here and use its Sid. Also, you will need to configure the Voice "REQUEST URL" on the TwiML app once you've got your server up and running. |
| TWILIO_API_KEY / TWILIO_API_SECRET | Your REST API Key information needed to create an Access Token - create one here. |
This project is configured to use a TwiML App, which allows us to easily set the Voice URLs for all Twilio phone numbers we purchase in this app.
Create a new TwiML app and use its Sid as the TWILIO_APP_SID environment variable wherever you run this app.
See the end of the "Local development" section for details on the exact URL to use in your TwiML app.
Once you have created your TwiML app, configure your Twilio phone number. If you don't have a Twilio phone number yet, you can purchase a new number in your Twilio Account Dashboard.
-
First, clone this repository and
cdinto its directory.git clone https://github.com/TwilioDevEd/browser-calls-node.git cd browser-calls-node -
Install dependencies.
npm install
-
Copy the sample configuration file and edit it to match your configuration.
cp .env.example .env
See Twilio Account Settings to locate the necessary environment variables.
-
Start MongoDB.
This app requires MongoDB to be running. See how to start the MongoDB service on Windows, MacOS, or Linux (choose your Linux distribution and then see "Run MongoDB Community Edition" in the installation instructions).
-
Run the application.
npm start
Alternatively you might also consider using nodemon for this. It works just like the node command, but automatically restarts your application when you change any source code files.
npm install -g nodemon nodemon ./bin/www
-
Expose your application to the wider internet using ngrok. This step is important because the application won't work as expected if you run it through localhost. Here, you could read more about why we recommend you to use ngrok.
ngrok http 3000
-
Once you have started ngrok, update your TwiML app's Voice URL setting to use your ngrok hostname, so it will look something like this:
http://88b37ada.ngrok.io/call/connectSee Create a TwiML App.
-
Everything is setup, now you can open two tabs in the browser to test the application.
-
To create a support ticket go to the
homepage. On this page you could fill some fields and create a ticket or you can call to support: -
To respond to support tickets go to the
dashboardpage (you should open two windows or tabs). On this page you could call customers and answers phone calls.
-
That's it!
If you have Docker already installed on your machine, you can use our docker-compose.yml to setup your project.
- Make sure you have the project cloned.
- Setup the
.envfile as outlined in the Local Development steps. - Run
docker-compose up. - Follow the steps in Local Development on how to expose your port to Twilio using a tool like ngrok and configure the remaining parts of your application.
You can run the tests locally by typing
npm test- The CodeExchange repository can be found here.
No warranty expressed or implied. Software is as is.