Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Create Tasks from Phone Calls using TwiML: Dequeue a Call to a Worker


In the previous step we created a Task from an incoming phone call using <Enqueue workflowSid="WW0123401234..">. In this step we will create another call and dequeue it to an eligible Worker when one becomes available.

Back in Part 1 of the Quickstart we created a Worker named Alice that is capable of handling both English and Spanish inquiries. With your Workspace open in the TaskRouter web portal(link takes you to an external page), click 'Workers' and click to edit the details of our Worker Alice. Ensure that Alice is set to a non-available Activity state such as 'Offline'. Next, edit Alice's JSON attributes and add a "contact_uri" field. Replace the dummy 555 number below with your own phone number.

Alice's modified JSON attributes:


_10
{"languages": ["en", "es"], "contact_uri": "+15555555555"}

Or, as displayed in the web portal:

Alice's Worker Details.

In this step, we again use <Enqueue> to create a Task from an incoming phone call. When an eligible Worker (in this case Alice) becomes available, TaskRouter will make a request to our Assignment Callback URL. This time, we will respond with a special 'dequeue' instruction; this tells Twilio to call Alice at her 'contact_uri' and bridge to the caller.

For this part of the Quickstart, although not totally necessary it will be useful to have two phones available - one to call your Twilio number, and one to receive a call as Alice. Experienced Twilio users might consider using Twilio Client as one of the endpoints.

Before we add the 'dequeue' assignment instruction we need to create a new Activity in our TaskRouter Workspace. One of the nice things about integrating TaskRouter with TwiML is that our Worker will automatically transition through various Activities as the call is assigned, answered and even hung up. We need an Activity for our Worker to transition to when the call ends.

With your Workspace open in the TaskRouter web portal(link takes you to an external page), click 'Activities' and then 'Create Activity'. Give the new Activity a name of 'WrapUp' and a value of 'unavailable'. Once you've saved it, make a note of the Activity Sid:

Create a WrapUp Activity.

To return the 'dequeue' assignment instruction, modify server.rb assignment_callback endpoint to now issue a dequeue instruction, substituting your new WrapUp ActivitySid between the curly braces:


server.rb

serverrb page anchor

_76
require 'rubygems'
_76
require 'twilio-ruby'
_76
require 'sinatra'
_76
require 'json'
_76
_76
set :port, 8080
_76
_76
# Get your Account Sid and Auth Token from twilio.com/user/account
_76
account_sid = '{{ account_sid }}'
_76
auth_token = '{{ auth_token }}'
_76
workspace_sid = '{{ workspace_sid }}'
_76
workflow_sid = '{{ workflow_sid }}'
_76
_76
@client = Twilio::REST::Client.new(account_sid, auth_token)
_76
_76
post '/assignment_callback' do
_76
# Respond to assignment callbacks with accept instruction
_76
content_type :json
_76
# from must be a verified phone number from your twilio account
_76
{
_76
"instruction" => "dequeue",
_76
"from" => "+15556667777",
_76
"post_work_activity_sid" => "WA0123401234..."
_76
}.to_json
_76
end
_76
_76
get '/create-task' do
_76
# Create a task
_76
task = @client.taskrouter.workspaces(workspace_sid)
_76
.tasks
_76
.create(
_76
attributes: {
_76
'selected_language' => 'es'
_76
}.to_json,
_76
workflow_sid: workflow_sid
_76
)
_76
task.attributes
_76
end
_76
_76
get '/accept_reservation' do
_76
# Accept a Reservation
_76
task_sid = params[:task_sid]
_76
reservation_sid = params[:reservation_sid]
_76
_76
reservation = @client.taskrouter.workspaces(workspace_sid)
_76
.tasks(task_sid)
_76
.reservations(reservation_sid)
_76
.update(reservation_status: 'accepted')
_76
reservation.worker_name
_76
end
_76
_76
get '/incoming_call' do
_76
Twilio::TwiML::VoiceResponse.new do |r|
_76
r.gather(action: '/enqueue_call', method: 'POST', timeout: 5, num_digits: 1) do |gather|
_76
gather.say('Para Español oprime el uno.', language: 'es')
_76
gather.say('For English, please hold or press two.', language: 'en')
_76
end
_76
end.to_s
_76
end
_76
_76
post '/enqueue_call' do
_76
digit_pressed = params[:Digits]
_76
if digit_pressed == 1
_76
language = "es"
_76
else
_76
language = "en"
_76
end
_76
_76
attributes = '{"selected_language":"'+language+'"}'
_76
_76
Twilio::TwiML::VoiceResponse.new do |r|
_76
r.enqueue workflowSid: workflow_sid do |e|
_76
e.task attributes
_76
end
_76
end.to_s
_76
end

This returns a very simple JSON object from the Assignment Callback URL:



_10
{"instruction":"dequeue", "from": "+15556667777", "post_work_activity_sid": "WA01234012340123401234"}

The JSON instructs Twilio to dequeue the waiting call and, because we don't include an explicit "to" field in our JSON, connect it to our Worker at their "contact_uri". This is convenient default behavior provided by TaskRouter.

In the next step, we test our incoming call flow from end-to-end.

Next: End-to-End Phone Call Task Assignment »


Rate this page: