Skip to content
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.

TwilioDevEd/clicktocall-php

Repository files navigation

Twilio

Click to Call PHP

This repository is archived and no longer maintained. Check out the Twilio Voice docs for links to other tutorials.

Set up

Requirements

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.
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

Local development

After the above requirements have been met:

  1. Clone this repository and cd into it

    git clone git://github.com/TwilioDevEd/clicktocall-php.git
    cd clicktocall-php
  2. Install PHP dependencies

    make install
  3. Set your environment variables

    cp .env.example .env

    See Twilio Account Settings to locate the necessary environment variables.

  4. Run the application

    make serve
  5. Expose the application to the wider internet

  6. Check out the app at http://<sub-domain>.ngrok.io.

    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 .env file as outlined in the Local Development steps.
  3. Run docker-compose up.
  4. 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.

Expose the Application to the Wider Internet

  1. Expose your application to the wider internet using ngrok. You can click here for more details. This step is important because the application won't work as expected if you run it through localhost.
 $ ngrok http 8000

Once ngrok is running, open up your browser and go to your ngrok URL. It will look something like this: http://<sub-domain>.ngrok.io

Unit and Integration Tests

You can run the Unit and Feature tests locally by typing:

./vendor/bin/phpunit
```                                                                                                                                   |

## Resources

- The CodeExchange repository can be found [here](https://github.com/twilio-labs/code-exchange/).

## License

[MIT](http://www.opensource.org/licenses/mit-license.html)

## Disclaimer

No warranty expressed or implied. Software is as is.

[twilio]: https://www.twilio.com