twilio-taskrouter.js

TaskRouter is Twilio's skills based routing system. With this library, you can manage your Workers in the browser or view the state of your Workspace.

NOTE: This SDK is in a Developer Preview Release. This version of TaskRouter is intended for Twilio Flex. If you are using it outside of Twilio Flex, you may encounter bugs and instability, and the underlying APIs available in this release may change in subsequent releases.

Installation

NPM

npm install twilio-taskrouter

Usage

The following is a simple example showing a Worker waiting for Reservations. For more information, refer to the API Docs.

1const TaskRouter = require('twilio-taskrouter');
2const Twilio = require('twilio');
3const AccessToken = Twilio.jwt.AccessToken;
4const TaskRouterGrant = AccessToken.TaskRouterGrant;
5
6const accountSid = '';
7const signingKeySid = '';
8const signingKeySecret = '';
9const workspaceSid = '';
10const workerSid = '';
11
12const token = createAccessToken(accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid);
13const alice = new TaskRouter.Worker(token);
14
15alice.on('ready', readyAlice => {
16    console.log(`Worker ${readyAlice.sid} is now ready for work`);
17});
18
19alice.on('reservationCreated', reservation => {
20    console.log(`Reservation ${reservation.sid} has been created for ${alice.sid}`);
21    console.log(`Task attributes are: ${reservation.task.attributes}`);
22
23    reservation.on('accepted', acceptedReservation => {
24      console.log(`Reservation ${acceptedReservation.sid} was accepted.`);
25    });
26
27    reservation.accept().then(acceptedReservation => {
28      console.log(`Reservation status is ${acceptedReservation.status}`);
29    }).catch((err) => {
30      console.log(`Error: ${err}`);
31    });
32});
33
34function createAccessToken(accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid) {
35    const taskRouterGrant = new TaskRouterGrant({
36        workerSid: workerSid,
37        workspaceSid: workspaceSid,
38        role: 'worker'
39    });
40
41    const accessToken = new AccessToken(accountSid, signingKeySid, signingKeySecret);
42    accessToken.addGrant(taskRouterGrant);
43    accessToken.identity = 'alice';
44
45    return accessToken.toJwt();
46}
47

Changelog

See CHANGELOG.md.

License

See LICENSE.md.

Building

Fork and clone the repository. Use npm to install node 8 (other versions may run into problems).

Then, install dependencies with:

yarn install

Then run the build script:

yarn build

The builds and docs will be placed in the dist/ directory.

Before commits, be sure to validate by running:

make lint

Testing

• Create a twilio account
• copy ./test/integration_test_setup/.env.example to ./test/integration_test_setup/.env
• set ACCOUNT_SID, AUTH_TOKEN, SIGNING_KEY_SID, SIGNING_KEY_SECRET
• Run ./test/integration_test_setup/RunIntegrationTestLocal.sh this will create everything needed for running E2E tests and run the tests

Contributing

Bug fixes welcome! If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial.