Twilio Client Quickstart for PHP
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.
About
This application should give you a ready-made starting point for writing your own voice apps with Twilio Client.
Implementations in other languages:
| .NET | Java | Python | Ruby | Node |
|---|---|---|---|---|
| Done | Done | Done | Done | Done |
Set up
Requirements
- PHP >= 7.2.5 and composer
- A Twilio account - sign up
Twilio Account Settings
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. |
| Phone number | A Twilio phone number in E.164 format - you can get one here |
| 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. |
| 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:
-
Clone this repository and
cdinto itgit clone [email protected]:TwilioDevEd/client-quickstart-php.git cd client-quickstart-php
-
Install PHP dependencies
make install
-
Set your environment variables
cp .env.example .env
On production, to avoid showing errors, you should set the variable
DISPLAY_ERRORSto0. For development, it can be set to1on development. For more information, read thisSee Twilio Account Settings to locate the necessary environment variables.
-
Run the application
make serve
-
Run ngrok:
ngrok http 8000
-
When ngrok starts up, it will assign a unique URL to your tunnel. It might be something like
https://asdf456.ngrok.io. Take note of this. -
Configure your TwiML app's Voice "REQUEST URL" to be your ngrok URL plus
/voice.php. For example:
Note: You must set your webhook urls to the
httpsngrok tunnel created.
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.
Docker
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
Unit and Integration Tests
You can run the Unit and Feature tests locally by typing:
bin/phpunit testsCloud 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 |  |
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
Disclaimer
No warranty expressed or implied. Software is as is.