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 | Java | Python | Ruby | Node |
|---|---|---|---|---|
| Done | Done | Done | TBD | Done |
- PHP >= 7.2.5 and composer
- A Twilio account - sign up
- The application uses sqlite3 as the persistence layer. If you don't have it already, you should install it.
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 |
|---|---|
| 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/airtng-laravel.git cd airtng-laravel
-
Set your environment variables
cp .env.example .env
See Twilio Account Settings to locate the necessary environment variables.
-
Install PHP dependencies
make install
-
Expose the application to the wider Internet using ngrok
$ ngrok http 8000
Once you have started ngrok, update your Twilio number sms URL settings to use your ngrok hostname. It will look something like this:
http://<your-ngrok-subdomain>.ngrok.io/reservation/incoming -
Configure Twilio to call your webhooks.
You will also 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 right 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.
Remember that the number where you change the sms webhooks must be the same one you set on the TWILIO_NUMBER environment variable.
For this application, you must set the voice webhook of your number so that it looks something like this:
http://<your-ngrok-subdomain>.ngrok.io/reservation/incoming
And in this case set the POST method on the configuration for this webhook.
-
Run the application
make serve
-
Navigate to http://localhost:8000
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.
First, run the migrations for the testing database.
php artisan migrate --database=testingYou can run the Unit tests locally by typing:
vendor/bin/phpunitAdditionally 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 |  |
- 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.