In this tutorial we will show how to automate the routing of calls from customers to your support agents. Customers will be able to select a product and wait while TaskRouter tries to contact a product specialist for the best support experience. If no one is available, our application will save the customer's number and selected product so an agent can call them back later on.
This is what the application does at a high level:
- Configure a workspace using the Twilio TaskRouter REST API.
- Listen for incoming calls and let the user select a product with the dial pad.
- Create a Task with the selected product and let TaskRouter handle it.
- Store missed calls so agents can return the call to customers.
A Workspace is the container element for any TaskRouter application. The elements are:
- Tasks - Represents a customer trying to contact an agent.
- Workers - The agents responsible for handling Tasks.
- Task Queues - Holds Tasks to be consumed by a set of Workers.
- Workflows - Responsible for placing Tasks into Task Queues.
- Activities - Possible states of a Worker, e.g. Idle, Offline, Busy.
In order to build a client for this API, we need as system variables a
TWILIO_AUTH_TOKEN which you can find on Twilio Console. The artisan command
workspace:create creates a
Twilio\Rest\Client, which is provided by the Twilio PHP library. This client is used by WorkspaceFacade which encapsulates all logic related to the creation of a Task Router workflow.
Let's take a look at that command next.
In this application the Artisan command
workspace:create is used to orchestrate calls to our
WorkspaceFacade class in order to build a Workspace from scratch.
CreateWorkspace is the PHP class behind the Artisan command. It uses data provided by
workspace.json and expects 3 arguments:
host- A public URL to which Twilio can send requests. This can be either a cloud service or ngrok, which can expose a local application to the internet.
bob_phone- The telephone number of Bob, the Programmable SMS specialist.
alice_phone- Same for Alice, the Programmable Voice specialist.
createWorkspaceConfig is used to load the configuration of the workspace from
Now let's look in more detail at all the steps, starting with the creation of the workspace itself.
Before creating a workspace, we need to delete any others with the same
friendlyName as identifier. In order to create a workspace we need to provide a
friendlyName, and a
eventCallbackUrl which contains an url to be called every time an event is triggered in the workspace.
We have a brand new workspace, now we need workers. Let's create them on the next step.
We'll create two workers, Bob and Alice. They each have two attributes:
contact_uri, a phone number, and
products, a list of products each worker is specialized in. We also need to specify an
activity_sid and a name for each worker. The selected activity will define the status of the worker.
After creating our workers, let's set up the Task Queues.
Next, we set up the Task Queues. Each with a name and a
targetWorkers property, which is an expression to match Workers. Our Task Queues are:
SMS- Will target Workers specialized in Programmable SMS, such as Bob, using the expression
"products HAS \"ProgrammableSMS\"".
Voice- Will do the same for Programmable Voice Workers, such as Alice, using the expression
"products HAS \"ProgrammableVoice\"".
All- This queue targets all users and can be used when there are no specialist around for the chosen product. We can use the
We have a Workspace, Workers and Task Queues... what's left? A Workflow. Let's see how to create one next!
Finally, we set up the Workflow using the following parameters:
friendlyNameas the name of a Workflow.
assignmentCallbackUrlas the public URL where a request will be made when this Workflow assigns a Task to a Worker. We will learn how to implement it on the next steps.
taskReservationTimeoutas the maximum time we want to wait until a Worker handles a Task.
configurationwhich is a set of rules for placing Task into Task Queues. The routing configuration will take a Task's attribute and match this with Task Queues. This application's Workflow rules are defined as:
SMSTask Queue. This expression will match any Task with
Our workspace is completely setup. Now it's time to see how we use it to route calls.
Right after receiving a call, Twilio will send a request to the URL specified on the number's configuration.
The endpoint will then process the request and generate a TwiML response. We'll use the Say verb to give the user product alternatives, and a key they can press in order to select one. The Gather verb allows us to capture the user's key press.
We just asked the caller to choose a product, next we will use their choice to create the appropiate Task.
This is the endpoint set as the
action URL on the
Gather verb on the previous step. A request is made to this endpoint when the user presses a key during the call. This request has a
Digits parameter that holds the pressed keys. A
Task will be created based on the pressed digit with the
selected_product as an attribute. The Workflow will take this Task's attributes and match them with the configured expressions in order to find a corresponding Task Queue, so an appropriate available Worker can be assigned to handle it.
After sending a Task to Twilio, let's see how we tell TaskRouter which Worker to use to execute that task.
When TaskRouter selects a Worker, it does the following:
- The Task's Assignment Status is set to
- A Reservation instance is generated, linking the Task to the selected Worker.
- At the same time the Reservation is created, a POST request is made to the Workflow's AssignmentCallbackURL, which was configured using the Artisan command
workspace:create. This request includes the full details of the Task, the selected Worker, and the Reservation.
Handling this Assignment Callback is a key component of building a TaskRouter application as we can instruct how the Worker will handle a Task. We could send a text, e-mail, push notifications or make a call.
Since we created this Task during a voice call with an
Enqueue verb, let's instruct TaskRouter to dequeue the call and dial a Worker. If we do not specify a
to parameter with a phone number, TaskRouter will pick the Worker's
We also send a
post_work_activity_sid which will tell TaskRouter which Activity to assign this worker after the call ends.
Now that our Tasks are routed properly, let's deal with missed calls in the next step.
This endpoint will be called after each TaskRouter Event is triggered. In our application, we are trying to collect missed calls, so we would like to handle the
workflow.timeout event. This event is triggered when the Task waits more than the limit set on Workflow Configuration-- or rather when no worker is available.
Here we use TwilioRestClient to route this call to a Voicemail Twimlet. Twimlets are tiny web applications for voice. This one will generate a
TwiML response using
Say verb and record a message using
Record verb. The recorded message will then be transcribed and sent to the email address configured.
We are also listening for
task.canceled. This is triggered when the customer hangs up before being assigned to an agent, therefore canceling the task. Capturing this event allows us to collect the information from the customers that hang up before the Workflow times out.
Most of the features of our application are implemented. The last piece is allowing the Workers to change their availability status. Let's see how to do that next.
We have created this endpoint, so a worker can send an SMS message to the support line with the command "On" or "Off" to change their availability status.
This is important as a worker's activity will change to
Offline when they miss a call. When this happens, they receive an SMS letting them know that their activity has changed, and that they can reply with the
On command to make themselves available for incoming calls again.
Congratulations! You finished this tutorial. As you can see, using Twilio's TaskRouter is quite simple.
If you're a PHP developer working with Twilio, you might also enjoy these tutorials:
Instantly collect structured data from your users with a survey conducted over a call or SMS text messages. Let's get started!
Learn how to implement ETA Notifications using Laravel and Twilio.
Thanks for checking out this tutorial! If you have any feedback to share with us, we'd love to hear it. Tweet @twilio to let us know what you think!