Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Browser Calls with PHP and Laravel

Download the Code

This Laravel web application shows how you can use Twilio Client to make browser-to-phone and browser-to-browser calls.

This application powers the support site for the Birchwood Bicycle Polo Co., which sells equipment to those who play "the sport of kings." It has three main features:

  • Unsatisfied customers can submit support tickets with their phone number and their problem
  • Support agents can call customers' phones from their browser to follow up on support tickets
  • Customers can also use their browser to speak with support agents live when available

In this tutorial, we'll point out the key bits of code that make this application work. Check out the project README on GitHub to see how to run the code yourself.

Learn how Zendesk uses Twilio Client to make phone support available in 40+ countries.

Let's get started!

Submit a support ticket

The home page of our app displays a form for customers to submit support tickets. We render a form template as part of the home page and handle the form submission in this controller.

The Ticket model itself has just a few fields. Here's the schema migration used to create it:

Schema::create(
    'tickets', function (Blueprint $table) {
        $table->increments('id');
        $table->string('name');
        $table->string('phone_number');
        $table->string('description');

        $table->timestamps();
    }
);
Loading Code Sample...
      
      
      
      
      app/Http/Controllers/TicketController.php

      Create a Ticket

      app/Http/Controllers/TicketController.php

      Now we can create a ticket. Next up, let's work on the dashboard for the support agent.

      Make a Dashboard for our Support Agents

      The support dashboard

      When a support agent visits /support/dashboard, they see all the support tickets which have been submitted.

      Each ticket also has a "Call Customer" button which invokes a JavaScript function we wrote named callCustomer(). That function kicks off a Twilio Client call to the phone number passed as its sole parameter.

      Loading Code Sample...
          
          
          
          
          resources/views/supportDashboard.blade.php

          Support Agent's Dashboard

          resources/views/supportDashboard.blade.php

          Great, now we have an interface good enough for our support agents. Next up, in order to let our agents make calls to their customers through the browser, we need to provide them a capability token.

          Let's learn how to generate a Capability Token

          Generate a capability token

          We use the Twilio PHP helper library to generate and configure our capability tokens. To allow our support agents to call the phone numbers on our tickets, we use the allowClientOutgoing() method.

          That method requires an identifier for a TwiML Application. Twilio will send a POST request to our backend every time a user makes a Twilio Client call — the TwiML Application tells Twilio which URL to send that request to.

          Loading Code Sample...
              
              
              
              
              app/Http/Controllers/TokenController.php

              Generate a capability token

              app/Http/Controllers/TokenController.php

              Once we are equipped with our Capability Token, the next step is to set up the Twilio Device Client in the browser.

              Time for some JavaScript!

              Set up a Twilio Device Client

              To use the Twilio Device Client in a web browser we use the twilio.js library.

              We start by retrieving a capability token from the view we defined in the previous step with a POST request through AJAX. Then we enable the Twilio Device Client for this page by passing our token to Twilio.Device.setup().

              After that the Twilio.Device.ready() callback will let us know when the browser is ready to make and receive calls.

              Loading Code Sample...
                  
                  
                  
                  
                  public/js/browser-calls.js

                  Set up a Twilio Device

                  public/js/browser-calls.js

                  Now that we have almost everything in place, it's time to see the core of this tutorial. Let's look at how we can let our agents start a call from their browsers.

                  Call a customer's phone from your browser

                  Calling a Customer (browser-to-phone)

                  When our support agents click on the Call Customer button on a support ticket, the function highlighted on the code snippet will initiate the call.

                  We use Twilio.Device.connect() to begin a new outgoing call. Our backend will tell Twilio how to handle this call, so we include a phoneNumber parameter that we'll use on our Connect route.

                  Loading Code Sample...
                      
                      
                      
                      
                      public/js/browser-calls.js

                      Call a Customer

                      public/js/browser-calls.js

                      Great! Now our agents are able to make calls to their customers. Next up, let's look at how to connect that call to a phone number.

                      Connect the Call to a Phone Number

                      Connect the call to a phone number

                      Whenever one of our users makes a call, Twilio will send a POST request to the URL we set on our TwiML Application - in this case, /support/call.

                      We use TwiML to respond to the request and tell Twilio how to handle the call. Twilio will pass along the phoneNumber parameter from the previous step in its request, which we will then Dial in our TwiML.

                      Loading Code Sample...
                          
                          
                          
                          
                          app/Http/Controllers/CallController.php

                          Connect the call to a phone number

                          app/Http/Controllers/CallController.php

                          After our call view responds, Twilio completes the connection between our support agent's browser and the customer's phone. Let's go back to the browser code and look at how to notify the agent of a call in progress.

                          Learn how to indicate a live call

                          The call is live

                          We use the Twilio.Device.connect() callback to update some UI elements to notify our users that they are in a call. This function receives a Connection object, which offers some additional details about the call.

                          Loading Code Sample...
                              
                              
                              
                              
                              public/js/browser-calls.js

                              Indicate a live call

                              public/js/browser-calls.js

                              And that's all for our browser-to-phone example. Next up, we will go even further and show a browser-to-browser example.

                              Have the customer start a call from their browser

                              Call a support agent (browser-to-browser)

                              Support tickets are useful, but sometimes a customer needs help right now. With just a little more work we let customers speak with a support agent live via a browser-to-browser call.

                              When a customer clicks "Call support" on the home page we again use Twilio.Device.connect() to initiate the call. This time we don't pass any additional parameters — our backend will route this call to our support agent.

                              Loading Code Sample...
                                  
                                  
                                  
                                  
                                  public/js/browser-calls.js

                                  Call a Support Agent

                                  public/js/browser-calls.js

                                  Setting up the browser-to-browser call was rather simple right? Now let's look at how our backend will route this call to our support agent.

                                  Connect an Incoming Call from the Customer

                                  Connect the call to the support agent's client

                                  To allow our support agents to accept incoming calls we use the allow_client_incoming() method when generating their capability token, passing support_agent as the client's name:

                                  $capability->allowClientIncoming('support_agent');
                                  

                                  When Twilio sends a POST request to our newCall view, we can connect the call to our support agent by responding with a Client TwiML noun and the support_agent name.

                                  Loading Code Sample...
                                      
                                      
                                      
                                      
                                      app/Http/Controllers/CallController.php

                                      Connect Incoming Calls

                                      app/Http/Controllers/CallController.php

                                      That's how we prepare everything for accepting incoming calls. Now we should go back in the browser and see how to handle the connection this time.

                                      Answer the call

                                      Answer the call

                                      When our support agent's client receives an incoming call, it will trigger the function we defined on the Twilio.Device.incoming() callback.

                                      The incoming connection will be in a pending state until we invoke its .accept() method, which we do in a function bound to the Answer Call button.

                                      We also set a .accept() callback to update the UI once the call is live.

                                      Loading Code Sample...
                                          
                                          
                                          
                                          
                                          public/js/browser-calls.js

                                          Answer the call

                                          public/js/browser-calls.js

                                          Great! Now we know how to work on both cases: browser-to-phone and browser-to-browser calls! Next up, we will see what happens when they decide to hang up the call.

                                          Hanging up the Call

                                          Hang up the Call

                                          In order to finish a call we invoke Twilio.Device.disconnectAll(), which we wired to the Hang up button in our UI.

                                          We also pass a callback function to Twilio.Device.disconnect() above, to reset some UI elements.

                                          Loading Code Sample...
                                              
                                              
                                              
                                              
                                              public/js/browser-calls.js

                                              Hang up the Call

                                              public/js/browser-calls.js

                                              That's it! Our Laravel application now powers browser-to-phone and browser-to-browser calls using Twilio Client.

                                              Where to Next?

                                              Where to next?

                                              If you're a PHP developer working with Twilio, you might also enjoy these tutorials:

                                              Click-To-Call

                                              Put a button on your web page that connects visitors to live support or sales people via telephone.

                                              Automated Survey

                                              Instantly collect structured data from your users with a survey conducted over a voice call or SMS text messages.

                                              Did this help?

                                              Thanks for checking this tutorial out! If you have any feedback to share with us please contact us on Twitter, we'd love to hear it.

                                              Mario Celi Jose Oliveros Agustin Camino David Prothero Andrew Baker Paul Kamp  Kat King

                                              Need some help?

                                              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                                              Loading Code Sample...