Creating Tasks and Accepting Reservations: Accept a Reservation using the REST API

To indicate that a Worker has accepted or rejected a Task, you make an HTTP
POST request to a Reservation instance resource. To do that, we need the
TaskSid, which is available via the web portal, and the ReservationSid. The
ReservationSid was passed to our Assignment Callback URL when a Worker was
reserved for our Task. Using the ngrok inspector page at http://localhost:4040, we can easily find the request parameters sent from
TaskRouter and copy the ReservationSid to our clipboard. **

With our trusty TaskSid and ReservationSid in hand, let's make another REST API request to accept our Task Reservation. We'll add on to our server.rb to accept a reservation with our web server. Remember to substitute your own account details in place of the curly braces.

server.rb

1
require 'rubygems'
2
require 'twilio-ruby'
3
require 'sinatra'
4
require 'json'
5
set :port, 8080
6

7
# Get your Account Sid and Auth Token from twilio.com/user/account
8
account_sid = '{{ account_sid }}'
9
auth_token = '{{ auth_token }}'
10
workspace_sid = '{{ workspace_sid }}'
11
workflow_sid = '{{ workflow_sid }}'
12

13
client = Twilio::REST::Client.new(account_sid, auth_token)
14

15
post '/assignment_callback' do
16
# Respond to assignment callbacks with empty 200 response
17
content_type :json
18
{}.to_json
19
end
20

21
get '/create-task' do
22
# Create a task
23
task = client.taskrouter.workspaces(workspace_sid)
24
.tasks
25
.create(
26
attributes: {
27
'selected_language' => 'es'
28
}.to_json,
29
workflow_sid: workflow_sid
30
)
31
task.attributes
32
end
33

34
get '/accept-reservation' do
35
# Accept a Reservation
36
task_sid = params[:task_sid]
37
reservation_sid = params[:reservation_sid]
38

39
reservation = client.taskrouter.workspaces(workspace_sid)
40
.tasks(task_sid)
41
.reservations(reservation_sid)
42
.update(reservation_status: 'accepted')
43
reservation.worker_name
44
end

If you'd like to use curl instead, put the following into your terminal:

1
curl https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{ReservationSid} \
2
-d ReservationStatus=accepted \
3
-u {AccountSid}:{AuthToken}

Examining the response from TaskRouter, we see that the Task Reservation has been accepted, and the Task has been assigned to the our Worker Alice:

{... "worker_name": "Alice", "reservation_status": "accepted", ...}

If you don't see this, it's possible that your Reservation has timed out. If this is the case, set your Worker back to an available Activity state and create another Task. To prevent this from occurring, you can increase the 'Task Reservation Timeout' value in your Workflow configuration.

With your Workspace open in the TaskRouter console, click 'Workers' and you'll see that Alice has been transitioned to the 'Assignment Activity' of the TaskQueue that assigned the Task. In this case, "Busy":

Expand image

Hurrah! We've made it to the end of the Task lifecycle:

Task Created → eligible Worker becomes available → Worker reserved → Reservation accepted → Task assigned to Worker.

In the next steps, we'll examine more ways to perform common Task acceptance and rejection workflows.

Next: Accept a Reservation using Assignment Instructions »

** If you're not using ngrok or a similar tool, you can modify server.rb to print the value of ReservationSid to your web server log. Or, you can use the Tasks REST API instance resource to look up the ReservationSid based on the TaskSid.