Skip to contentSkip to navigationSkip to topbar
Rate this page:
On 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 run.py to accept a reservation with our web server. Remember to substitute your own account details in place of the curly braces.


run.py

runpy page anchor

_49
from flask import Flask, request, Response
_49
from twilio.rest import Client
_49
_49
app = Flask(__name__)
_49
_49
# Your Account Sid and Auth Token from twilio.com/user/account
_49
account_sid = "{{ account_sid }}"
_49
auth_token = "{{ auth_token }}"
_49
workspace_sid = "{{ workspace_sid }}"
_49
workflow_sid = "{{ workflow_sid }}"
_49
_49
client = Client(account_sid, auth_token)
_49
_49
@app.route("/assignment_callback", methods=['GET', 'POST'])
_49
def assignment_callback():
_49
"""Respond to assignment callbacks with empty 200 response"""
_49
_49
resp = Response({}, status=200, mimetype='application/json')
_49
return resp
_49
_49
@app.route("/create_task", methods=['GET', 'POST'])
_49
def create_task():
_49
"""Creating a Task"""
_49
task = client.taskrouter.workspaces(workspace_sid).tasks.create(
_49
workflow_sid=workflow_sid,
_49
attributes='{"selected_language":"es"}'
_49
)
_49
print(task.attributes)
_49
resp = Response({}, status=200, mimetype='application/json')
_49
return resp
_49
_49
@app.route("/accept_reservation", methods=['GET', 'POST'])
_49
def accept_reservation():
_49
"""Accepting a Reservation"""
_49
task_sid = request.args.get('task_sid')
_49
reservation_sid = request.args.get('reservation_sid')
_49
_49
reservation = client.taskrouter.workspaces(workspace_sid) \
_49
.tasks(task_sid) \
_49
.reservations(reservation_sid) \
_49
.update(reservation_status='accepted')
_49
print(reservation.reservation_status)
_49
print(reservation.worker_name)
_49
_49
resp = Response({}, status=200, mimetype='application/json')
_49
return resp
_49
_49
if __name__ == "__main__":
_49
app.run(debug=True)

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


_10
curl -X POST 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 occuring, you can increase the 'Task Reservation Timeout' value in your Workflow configuration.

With your Workspace open in the TaskRouter web portal(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 has been transitioned to the Busy Activity.

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 acception and rejection workflows.

Next: Accept a Reservation using Assignment Instructions »

** If you're not using ngrok or a similar tool, you can modify run.py 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: