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, 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:

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

Or, as displayed in the web portal:

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 the Twilio Dev Phone 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, 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:

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

1require 'rubygems'
2require 'twilio-ruby'
3require 'sinatra'
4require 'json'
5
6set :port, 8080
7
8# Get your Account Sid and Auth Token from twilio.com/user/account
9account_sid = '{{ account_sid }}'
10auth_token = '{{ auth_token }}'
11workspace_sid = '{{ workspace_sid }}'
12workflow_sid = '{{ workflow_sid }}'
13
14@client = Twilio::REST::Client.new(account_sid, auth_token)
15
16post '/assignment_callback' do
17  # Respond to assignment callbacks with accept instruction
18  content_type :json
19  # from must be a verified phone number from your twilio account
20  {
21    "instruction" => "dequeue",
22    "from" => "+15556667777",
23    "post_work_activity_sid" => "WA0123401234..."
24  }.to_json
25end
26
27get '/create-task' do
28  # Create a task
29  task = @client.taskrouter.workspaces(workspace_sid)
30                            .tasks
31                            .create(
32                                attributes: {
33                                      'selected_language' => 'es'
34                            }.to_json,
35                                workflow_sid: workflow_sid
36                            )
37  task.attributes
38end
39
40get '/accept_reservation' do
41  # Accept a Reservation
42  task_sid = params[:task_sid]
43  reservation_sid = params[:reservation_sid]
44
45  reservation = @client.taskrouter.workspaces(workspace_sid)
46                        .tasks(task_sid)
47                        .reservations(reservation_sid)
48                        .update(reservation_status: 'accepted')
49  reservation.worker_name
50end
51
52get '/incoming_call' do
53  Twilio::TwiML::VoiceResponse.new do |r|
54    r.gather(action: '/enqueue_call', method: 'POST', timeout: 5, num_digits: 1) do |gather|
55      gather.say('Para Español oprime el uno.', language: 'es')
56      gather.say('For English, please hold or press two.', language: 'en')
57    end
58  end.to_s
59end
60
61post '/enqueue_call' do
62  digit_pressed = params[:Digits]
63  if digit_pressed == 1
64    language = "es"
65  else
66    language = "en"
67  end
68
69  attributes = '{"selected_language":"'+language+'"}'
70
71  Twilio::TwiML::VoiceResponse.new do |r|
72    r.enqueue workflowSid: workflow_sid do |e|
73      e.task attributes
74    end
75  end.to_s
76end

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

JSON Output

{"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 »