If you are using Twilio TaskRouter SDK version 1, it's critical that you update to version 2 to ensure that your systems stay current, robust, and well-supported with the latest improvements and developments. TaskRouter SDK version 2 is not just the newer version, but it is the platform that Twilio will provide long-term support for.
Please note that updates and support for TaskRouter SDK version 1 will be discontinued, and only version 2 will continue to be updated.
accepted
,
canceled
,
rejected
,
rescinded
, and
timed out
.
Performance enhancements: Version 2 reduces the need for multiple round-trips to the API by:
As a result of these updates, a hard refresh is required to re-fetch from the API in version 2.
When you migrate to TaskRouter SDK version 2, you'll need to make updates for the following changes:
Complete the following steps to upgrade to TaskRouter SDK version 2 and address any breaking changes.
The main changes from v1 to v2 are the migration of callbacks to promises and different organization of the worker's activity and event handling. The SDK is now more efficient, accomplished by sending the entire Task and Reservation payload down the JS SDK and listing all active Tasks and Reservations for the Worker in memory.
Use the information in this section to update your workers, events, and reservations for version 2.
Version 2 uses promises instead of callbacks.
_10worker.on("ready", function(worker) {_10 updateWorker(worker);_10});
_10worker.on('ready', () => {_10 updateWorker(worker);_10});
In version 1, the activity was defined by properties. In version 2, the worker has an activity object instead.
_10function updateWorker(worker) {_10 console.log(worker.activityName);_10 console.log(worker.available);_10}
_10function updateWorker(worker) {_10 console.log(worker.activity.name);_10 console.log(worker.activity.available);_10}
Version 1 used a fetchActivityList function call to fetch the API workspace activity list. In version 2, you can simply loop through worker.activities.
_10worker.fetchActivityList(_10 function(error, activityList) { //body} );
_10worker.activities.forEach((activity) => {_10 console.log(activity.name);_10});
_10worker.updateActivity(onlineActivitySid);
_10worker.activities.forEach((activity) => {_10 if (activity.name === 'Idle') {_10 activity.setAsCurrent().then(() => {_10 console.log(worker.activity.name);_10 });_10 }_10});
_10worker.on("activity.update", function(worker) {_10 updateWorker(worker);_10});
_10worker.on("activityUpdated",_10function(worker) {_10 updateWorker(worker);_10});
In version 2, you must have an event handler for reservation before you can listen for reservation events (accepted, canceled, rejected, rescinded, and timed out).
_10worker.on("reservation.accepted", function(reservation) {_10 console.log(reservation.task.attributes);_10});
_10worker.on(“reservationCreated”, function(reservation) {_10 reservation.on(“accepted”, function(reservation) {_10 console.log(reservation.task.attributes);_10 });_10});