Skip to contentSkip to navigationSkip to topbar
Rate this page:

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. **

(information)

Info

The Reservation API resource is ephemeral and exists only within the context of a Task. As such, it doesn't have its own primary API resource and you'll find it documented in the Tasks resource section of the reference documentation.

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


_44
require 'rubygems'
_44
require 'twilio-ruby'
_44
require 'sinatra'
_44
require 'json'
_44
set :port, 8080
_44
_44
# Get your Account Sid and Auth Token from twilio.com/user/account
_44
account_sid = '{{ account_sid }}'
_44
auth_token = '{{ auth_token }}'
_44
workspace_sid = '{{ workspace_sid }}'
_44
workflow_sid = '{{ workflow_sid }}'
_44
_44
client = Twilio::REST::Client.new(account_sid, auth_token)
_44
_44
post '/assignment_callback' do
_44
# Respond to assignment callbacks with empty 200 response
_44
content_type :json
_44
{}.to_json
_44
end
_44
_44
get '/create-task' do
_44
# Create a task
_44
task = client.taskrouter.workspaces(workspace_sid)
_44
.tasks
_44
.create(
_44
attributes: {
_44
'selected_language' => 'es'
_44
}.to_json,
_44
workflow_sid: workflow_sid
_44
)
_44
task.attributes
_44
end
_44
_44
get '/accept-reservation' do
_44
# Accept a Reservation
_44
task_sid = params[:task_sid]
_44
reservation_sid = params[:reservation_sid]
_44
_44
reservation = client.taskrouter.workspaces(workspace_sid)
_44
.tasks(task_sid)
_44
.reservations(reservation_sid)
_44
.update(reservation_status: 'accepted')
_44
reservation.worker_name
_44
end

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


_10
curl https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{ReservationSid} \
_10
-d ReservationStatus=accepted \
_10
-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:


_10
{... "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(link takes you to an external page), 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":

Alice is Busy.

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.


Rate this page: