⚠️

This is a deprecated project.

Please go to the Twilio Voice JavaScript SDK quickstart for Java

⚠️

Twilio Client Quickstart for Java

Set up

Requirements

• Java Development Kit version 11 or later.
• ngrok
• A Twilio account - sign up

Twilio Account Settings

This application should give you a ready-made starting point for writing your own appointment reminder 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 here.
TWILIO_TWIML_APP_SID	The TwiML application with a voice URL configured to access your server running this app - create one in the console here. Also, you will need to configure the Voice "REQUEST URL" on the TwiML app once you've got your server up and running.
TWILIO_CALLER_ID	A Twilio phone number in E.164 format - you can get one here
API_KEY / API_SECRET	Your REST API Key information needed to create an Access Token - create one here.

Local development

After the above requirements have been met:

1. Clone this repository and cd into it

   git clone git@github.com:TwilioDevEd/client-quickstart-java.git
   cd client-quickstart-java

2. Set your environment variables

   cp .env.example .env

   See Twilio Account Settings to locate the necessary environment variables.

3. Build the project

   make install

   NOTE: Running the build task will also run the tests

4. Run the application

   make serve

   NOTE: If you are using a dedicated Java IDE like Eclipse or IntelliJ, you can start the application within the IDE and it will start in development mode, which means any changes on a source file will be automatically reloaded.

5. Navigate to http://localhost:8080

That's it!

Docker

If you have Docker already installed on your machine, you can use our docker-compose.yml to setup your project.

1. Make sure you have the project cloned.
2. Setup the environmental variables in the docker-compose.yml file, see the Twilio Account Settings.
3. Run docker-compose --env-file /dev/null up.
4. Follow the steps in Configure Twilio section on how to expose your port to Twilio using a tool like ngrok and configure the remaining parts of your application.

Tests

You can run the tests locally by typing:

mvn clean test

Configure Twilio

To let our Twilio Phone number use the callback endpoint we exposed our development server will need to be publicly accessible. We recommend using ngrok to solve this problem.

To start using ngrok in our project you'll have to execute the following line in the command prompt.

ngrok http 8080 -host-header="localhost:8080"

Keep in mind that our endpoint is:

http://<your-ngrok-subdomain>.ngrok.io/voice

Configure your TwiML app's Voice "REQUEST URL" to be your ngrok URL plus /voice. For example:

![screenshot of twiml app](https://s3.amazonaws.com/com.twilio.prod.twilio-docs/images/TwilioClientRequestUrl.original.png)

You should now be ready to rock! Make some phone calls. Open it on another device and call yourself. Note that Twilio Client requires WebRTC enabled browsers, so Edge and Internet Explorer will not work for testing. We'd recommend Google Chrome or Mozilla Firefox instead.

Note: You must set your webhook urls to the https ngrok tunnel created.

Cloud deployment

Additionally 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

Some notes:

• For Heroku, please check this to properly configure the project for deployment.
• You can also follow this guide to deploy the application to several other cloud services including Google Cloud, Oracle Cloud, etc.

Resources

• The CodeExchange repository can be found here.

Contributing

This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.