We are currently in the process of updating this sample template. If you are encountering any issues with the sample, please open an issue at github.com/twilio-labs/code-exchange/issues and we'll try to help you.
Learn how to automate your workflow using Twilio's REST API and Twilio SMS. This example app is a vacation rental site, where the host can confirm a reservation via SMS.
Implementations in other languages:
| .NET | Python | Node | PHP | Ruby |
|---|---|---|---|---|
| Done | Done | Done | Done | TBD |
- Java Development Kit version 11 or later.
- ngrok
- PostgreSQL
- A Twilio account - sign up
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 |
|---|---|
| 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]:TwilioDevEd/airntg-servlets.git cd airntg-servlets
-
Set your environment variables
cp .env.example .env
See Twilio Account Settings to locate the necessary environment variables.
-
Create the database.
createdb airtng-servlets
-
Execute the migrations.
./gradlew flywayMigrate
-
Build the project
make install
NOTE: Running the build task will also run the tests
-
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.
-
Navigate to http://localhost:8080
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 environmental variables in the
docker-compose.ymlfile, see the Twilio Account Settings. - Run
docker-compose --env-file /dev/null up. - 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.
You can run the tests locally by typing:
./gradlew testYou will need to configure Twilio to send requests to your application when SMS are received.
You will need to provision at least one Twilio number with sms capabilities so the application's users can make property reservations. You can buy a number here. Once you have a number, you need to configure it to work with your application. Open the number management page and open a number's configuration by clicking on it.
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.
Remember that the number you change the SMS webhook for must be the same one you set on the TwilioPhoneNumber setting.
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/reservation-confirmation
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.
- The CodeExchange repository can be found here.
This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.
No warranty expressed or implied. Software is as is.