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

TwilioDevEd/conference-broadcast-laravel

Repository files navigation

Twilio

Rapid Response Kit: Building Conferencing and Broadcasting with Twilio.

Level: Intermediate. Powered by Twilio - Laravel

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

An example application implementing an disaster response kit that allows an organizer to instantly communicate with volunteers.

Read the full tutorial!

Implementations in other languages:

.NET Java Python Ruby Node
Done Done TBD Done TDB

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/conference-broadcast-laravel.git
    cd conference-broadcast-laravel
  2. Set your environment variables

    cp .env.example .env

    See Twilio Account Settings to locate the necessary environment variables.

  3. Install PHP dependencies

    make install
  4. Run the application

    make serve
  5. Expose the application to the wider Internet using ngrok

    $ ngrok http 8000

    Once you have started ngrok, update your TwiML app's voice URL setting to use your ngrok hostname, so it will look something like this:

    https://<your-ngrok-subdomain>.ngrok.io/conference/join
    
  6. Configure Twilio to call your webhooks You will also need to configure Twilio to call your application when calls are received.

    You will need to provision at least one Twilio number with voice capabilities so the application's users can participate in conferences. You can buy a number right here. Once you have a number you need to configure your number 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 voice webhooks must be the same one you set on the TWILIO_RR_NUMBER environment variable.

    Configure Voice

    For this application, you must set the voice webhook of your number to something like this:

    https://<your-ngrok-subdomain>.ngrok.io/conference/join
    

    And in this case set the GET method on the configuration for this webhook.

  7. Navigate to https://<your-ngrok-subdomain>.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.

Unit and Integration Tests

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

./vendor/bin/phpunit

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 Deploy

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.

Visit the project on GitHub

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.

About

Sample app of a Rapid Response Kit that showcases Twilio Voice conferencing and broadcasting

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages