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

Creating Tasks and Accepting Reservations: Create a Task using the REST API


Recall the TaskRouter Task lifecycle:

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

Before we create our first Task, make sure that our Worker Alice is in a non-available Activity state. Bob's Activity state won't matter right now, as we will create a Spanish language Task that he is not eligible to handle.

With your Workspace open in the TaskRouter web portal(link takes you to an external page), click 'Workers' then click to edit Alice and set her Activity to 'Offline'. Your Workers should look like this:

Ensure Alice is Offline.

To simulate reality, we'll create a Task using the REST API rather than the web portal. Create a PHP file called 'create-task.php' and add the code below. Replace the {} with your Twilio AccountSid, Twilio AuthToken, WorkspaceSid, and WorkflowSid.

create-task.php

create-taskphp page anchor

_30
<?php
_30
// Get the Twilio-PHP library from twilio.com/docs/libraries/php,
_30
// following the instructions to install it with Composer.
_30
require_once "vendor/autoload.php";
_30
use Twilio\Rest\Client;
_30
_30
// put your Twilio API credentials here
_30
// To set up environmental variables, see http://twil.io/secure
_30
$accountSid = getenv('TWILIO_ACCOUNT_SID');
_30
$authToken = getenv('TWILIO_AUTH_TOKEN');
_30
_30
// Set your WorkspaceSid and WorkflowSid
_30
$workspaceSid = 'WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
_30
$workflowSid = 'WWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
_30
_30
// instantiate a new Twilio Rest Client
_30
$client = new Client($accountSid, $authToken);
_30
_30
// create a new task
_30
$task = $client->taskrouter
_30
->workspaces($workspaceSid)
_30
->tasks
_30
->create(array(
_30
'attributes' => '{"selected_language": "es"}',
_30
'workflowSid' => $workflowSid,
_30
));
_30
_30
_30
// display a confirmation message on the screen
_30
echo "Created a new task";

Alternatively, we can also create a Task using the command line utility curl, which should exist on any Mac or Linux workstation. Again, remember to replace the {} with your matching credentials and Sids, then execute the following command at your terminal:


_10
curl https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks \
_10
--data-urlencode Attributes='{"selected_language": "es"}' \
_10
-d WorkflowSid={WorkflowSid} \
_10
-u {AccountSid}:{AuthToken}

You can find your Twilio AccountSid and AuthToken on the TaskRouter Getting Started page(link takes you to an external page) by clicking 'show API credentials'.

If you don't have curl, you can run this request using an HTTP test tool like Insomnia(link takes you to an external page) or using the Task creation dialog in the TaskRouter web portal: with your Workspace open, click 'Tasks' then 'Create Task'.

To see our newly created Task in the TaskRouter web portal, with your Workspace open, click 'Tasks' in the main navigation. Notice that the Task has been added to the "Customer Care Requests - Spanish" Task Queue based on the Attributes we provided in the curl request. The Assignment Status is 'pending' because there is no available Worker that matches the Task Queue:

Task in the TaskRouter web portal.

Make an Eligible Worker Available

make-an-eligible-worker-available page anchor

Look again at the TaskRouter Task lifecycle:

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

The first stage - 'Task Created' - is complete. To trigger an automatic Task Reservation, the next step is to bring en eligible Worker (in this case Alice) online.

With your Workspace open in the TaskRouter web portal, click 'Workers', then click to edit Alice and set her Activity to 'Idle':

Set Alice to Idle.

When you hit save, Twilio will create a Reservation between Alice and our Task and you will receive a Webhook request at the Assignment Callback URL that we set up in the previous step. If you're using ngrok, open http://localhost:4040 in your web browser to see a detailed log of the request that Twilio made to your server, including all the parameters that your server might use to determine whether to accept a Reservation:

ngrok Request Log.

We're now one step further along the Task Reservation lifecycle:

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

Time to accept the Reservation.

Next: Accept a Reservation with the REST API »


Rate this page: