twilio-taskrouter 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+2.0.4
+==========
+Maintenance
+----------
+- Enhanced websocket reconnection logic.
+
+2.0.3
+==========
+Bug Fixes
+----------
+- Fixed the type of `eventHandlerClass` in `WorkerOptions`
+
 2.0.2
 ==========
 Bug Fixes

package/dist/docs/Activity.html

@@ -1157,7 +1157,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Channel.html

@@ -1732,7 +1732,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/IncomingTransfer.html

@@ -641,7 +641,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/OutgoingTransfer.html

@@ -1341,7 +1341,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Reservation.html

@@ -3929,7 +3929,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Supervisor.html

@@ -4291,7 +4291,7 @@ TaskSid of the created Task.</li>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Task.html

@@ -4800,7 +4800,7 @@ provided, defaults to dateCreated.</p></td>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/TaskQueue.html

@@ -1635,7 +1635,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Transfers.html

@@ -747,7 +747,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Worker.html

@@ -4149,7 +4149,7 @@ TaskSid of the created Task.</li>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Workspace.html

@@ -1231,7 +1231,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/classes.list.html

@@ -5346,7 +5346,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/global.html

@@ -4827,7 +4827,7 @@ provided, defaults to dateCreated.</p></td>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/index.html

@@ -255,7 +255,7 @@ request/contribution process, <a href="https://gun.io/blog/how-to-github-fork-br
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2024-01-30T13:14:08+00:00
+		on 2024-04-17T12:33:19+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/quicksearch.html

@@ -6,7 +6,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Global Type Definitions ActivityUpdateOptions Type: Object Properties: Name Type Argument Default Description rejectPendingReservations boolean &lt;optional&gt; false Represents whether all pending reservations should be rejected with the update to an unavailable Activity. CallOptions Type: Object Properties: Name Type Argument Default Description accept boolean &lt;optional&gt; false Represents whether the Task should be accepted before initiating the call record string &lt;optional&gt; 'do-not-record' To record the call or not statusCallbackUrl string &lt;optional&gt; null A valid status status callback url to string &lt;optional&gt; null The number or endpoint that should be called. If not provided, the contact_uri defined in the Worker attributes will be used timeout number &lt;optional&gt; 60 The integer number of seconds Twilio should allow the phone associated to \"contact_uri\" to ring ConferenceOptions Type: Object Properties: Name Type Argument Default Description to string &lt;optional&gt; null The contact uri of the Worker; can be a phone number or a client ID. Required, if no contact_uri on the Worker's attributes. from string &lt;optional&gt; null The caller id for the call to the Worker. Must be a verified Twilio number. timeout number &lt;optional&gt; 60 The integer number of seconds that Twilio should allow the call to ring before assuming there is no answer. statusCallback string &lt;optional&gt; null The URL endpoint to receive call status events of the Worker leg. statusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method for the Status Callback URL. statusCallbackEvent string &lt;optional&gt; 'completed' A comma separated list of events to subscribe to. The possible list of events are: ['initiated', 'ringing', 'answered', 'completed']. record string &lt;optional&gt; 'do-not-record' Whether to record the Worker leg of the Conference. muted boolean &lt;optional&gt; false Whether the Worker leg of the Conference is muted. beep string | boolean &lt;optional&gt; true Whether the Worker leg should be when entering the Conference. The options for beep are: [true, false, 'onEnter', 'onExit']. startConferenceOnEnter boolean &lt;optional&gt; true Whether the Conference should start when the Worker leg enters. endConferenceOnExit boolean &lt;optional&gt; false Whether the Conference should end when the Worker leg exits. endConferenceOnCustomerExit boolean &lt;optional&gt; false Whether the Conference should end when the customer leg exits. beepOnCustomerEntrance boolean &lt;optional&gt; true Whether the Conference should beep when the customer leg enters. waitUrl string &lt;optional&gt; default Twilio hold music The URL endpoint to play when waiting for the Conference to begin. waitMethod string &lt;optional&gt; 'POST' The HTTP method for the Wait URL. earlyMedia boolean &lt;optional&gt; true Whether Twilio should feed early media to be played directly into a Conference. maxParticipants number &lt;optional&gt; 10 The number of max participants allowed in a Conference. conferenceStatusCallback string &lt;optional&gt; null The URL endpoint to receive Conference status events. conferenceStatusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method for the Conference Status Callback URL. conferenceStatusCallbackEvent string &lt;optional&gt; 'start,end' A comma separated list of Conference events to subscribe to. The possible list of events are: ['start', 'end', 'join', 'leave', 'mute', 'hold', 'speaker']. conferenceRecord string | boolean &lt;optional&gt; false Whether the entire Conference should be recorded. The possible options for conferenceRecord are: [true, false, 'record-from-start', 'do-not-record']. conferenceTrim string &lt;optional&gt; 'trim-silence' Whether to trim the Conference recording. The options for conferenceTrim are: ['trim-silence', 'do-not-trim']. recordingChannels string &lt;optional&gt; 'mono' Which channel of the Conference to record. The options are: ['mono', 'dual']. recordingStatusCallback string &lt;optional&gt; null The URL endpoint to receive recording status events. recordingStatusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method for the Recording Status Callback URL. conferenceRecordingStatusCallback string &lt;optional&gt; null The URl endpoint to receive Conference events. conferenceRecordingStatusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method of the Conference Recording Status Callback. region string &lt;optional&gt; null The specific region. The options for region are: ['us1', 'ie1', 'sg1', 'br1', 'au1', 'jp1']. sipAuthUsername string &lt;optional&gt; null The SIP auth username to use. sipAuthPassword string &lt;optional&gt; null The SIP auth password to use. transcribe boolean &lt;optional&gt; false Whether the call recording should be transcribed or not. transcriptionConfiguration string &lt;optional&gt; null The SID or (unique) friendly name of the transcription configuration object to use. DequeueOptions Type: Object Properties: Name Type Argument Default Description from string &lt;optional&gt; null The caller id for the call to the Worker. Must be a verified Twilio number. to string &lt;optional&gt; null The contact uri of the Worker; can be a phone number or a client ID. Required, if no contact_uri on the Worker's attributes. postWorkActivitySid string &lt;optional&gt; null The activitySid to update the Worker to after dequeuing the Reservation. record string &lt;optional&gt; 'do-not-record' Defines which legs of the call should be recorded. timeout number &lt;optional&gt; 60 The integer number of seconds that Twilio should allow the call to ring before assuming there is no answer. statusCallbackUrl string &lt;optional&gt; null A URL that Twilio will send asynchronous webhook this._request. to on a completed call event. statusCallbackEvents string &lt;optional&gt; null A comma separated string of the events to subscribe to FetchTaskQueuesParams Type: Object Properties: Name Type Argument Description AfterSid string &lt;optional&gt; FriendlyName string &lt;optional&gt; Ordering \"DateUpdated:asc\" | \"DateUpdated:desc\" &lt;optional&gt; WorkerSid string &lt;optional&gt; FetchWorkersParams Type: Object Properties: Name Type Argument Description AfterSid string &lt;optional&gt; FriendlyName string &lt;optional&gt; ActivitySid string &lt;optional&gt; ActivityName string &lt;optional&gt; TargetWorkersExpression string &lt;optional&gt; Ordering \"DateStatusChanged:asc\" | \"DateStatusChanged:desc\" &lt;optional&gt; MaxWorkers number &lt;optional&gt; RedirectOptions Type: Object Properties: Name Type Argument Default Description accept boolean &lt;optional&gt; false Represents whether the Task should be accepted before initiating the call RejectOptions Type: Object Properties: Name Type Description activitySid string The sid of the Activity to update the worker to upon rejecting the Reservation ReservationParticipantOptions Type: Object Properties: Name Type Description endConferenceOnExit boolean Whether the Conference should end when this Worker participant leaves the Conference mute boolean Mute or unmute this Worker participant beepOnExit boolean Whether there should be a beep sound when this Worker participant leaves the Conference TaskHoldOptions Type: Object Properties: Name Type Argument Description holdUrl string &lt;optional&gt; The URL endpoint to play when participant is on hold. holdMethod 'GET' &lt;optional&gt; The HTTP method for the hold URL. TaskParticipantOptions Type: Object Properties: Name Type Description hold boolean Whether to hold the customer leg of the Conference referenced by the Task holdUrl string The URL endpoint to play when participant is on hold. holdMethod 'GET' The HTTP method for the hold URL. TransferOptions Type: Object Properties: Name Type Default Description attributes Record.&lt;any, any&gt; Updated attributes for the task mode 'WARM' | 'COLD' 'WARM' 'WARM' or 'COLD' priority number Updated priority for the task WorkerDeps Type: Object Properties: Name Type Description Request Request EventBridgeSignaling EventBridgeSignaling WorkerOptions Type: Object Properties: Name Type Argument Default Description connectActivitySid string &lt;optional&gt; '' The Activity state of the Worker upon connect closeExistingSessions boolean &lt;optional&gt; false Whether other open sessions of this Worker should be terminated logLevel string &lt;optional&gt; 'error' The level of logging to enable ['error', 'warn', 'info', 'debug', 'trace', 'silent'] region string &lt;optional&gt; the realm for connections (ex. \"stage-us1\") WorkerTaskOptions Type: Object Properties: Name Type Argument Default Description attributes Record.&lt;any, any&gt; &lt;optional&gt; null Additional attributes for the Task taskChannelUniqueName string &lt;optional&gt; null The friendly name of the Channel this Task belongs to. If not provided, defaults to 'default' channel. taskChannelSid string &lt;optional&gt; null The Sid of the Channel this Task belongs to. If not provided, defaults to 'default' channel. virtualStartTime Date &lt;optional&gt; null Optional manually set starting time of the Task, in cases where the interaction between the customer and agents spans across multiple tasks. If not provided, defaults to dateCreated. WorkspaceOptions Type: Object Properties: Name Type Argument Default Description region string &lt;optional&gt; the realm for connections (ex. \"stage-us1\") pageSize number &lt;optional&gt; The number of items returned in each request logLevel string &lt;optional&gt; 'error' The level of logging to enable ['error', 'warn', 'info', 'debug', 'trace', 'silent'] WrappingOptions Type: Object Properties: Name Type Default Description reason string null The reason for wrapping up the Task × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Classes Classes Activity Channel IncomingTransfer OutgoingTransfer Reservation Supervisor Task TaskQueue Transfers Worker Workspace Events availabilityUpdated The availability of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose availability was updated capacityUpdated The capacity of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose capacity was updated attemptFailed The attempt to transfer the Task to the desired entity failed Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that had an attempt failure canceled The Task's current OutgoingTransfer has successfully been cancelled Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was canceled completed The OutgoingTransfer has successfully been transferred to the desired entity Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was completed failed All attempts to transfer the Task to the desired entity have failed. No more attempts on the OutgoingTransfer will be made. Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that has failed accepted Fired when a Reservation has been accepted for this Worker Parameters: Name Type Description reservation Reservation The accepted Reservation canceled Fired when a Reservation has been canceled for this Worker Parameters: Name Type Description reservation Reservation The canceled Reservation completed Fired when an accepted Reservation has been completed for this Worker Parameters: Name Type Description reservation Reservation The completed Reservation rejected Fired when a Reservation has been rejected for this Worker Parameters: Name Type Description reservation Reservation The rejected Reservation rescinded Fired when a Reservation has been rescinded for the Worker Parameters: Name Type Description reservation Reservation The rescinded Reservation timeout Fired when a Reservation has been timed out for this Worker Parameters: Name Type Description reservation Reservation The timed out Reservation wrapup Fired when a Reservation has been wrapped up for the Worker Parameters: Name Type Description reservation Reservation The wrapped up Reservation activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:activityUpdated attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:attributesUpdated disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected Inherited From: Worker#event:disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred Inherited From: Worker#event:error monitor Add this Supervisor to an ongoing Reservation by Sid. Parameters: Name Type Argument Description taskSid string The sid of the Task to add a monitor to. reservationSid string The sid of the Reservation to add a monitor to. extraParams Object &lt;optional&gt; An object containing extra params to append to the payload. ready Worker is ready to listen for events and take action Inherited From: Worker#event:ready reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation Inherited From: Worker#event:reservationCreated reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation Inherited From: Worker#event:reservationFailed tokenExpired The Worker token has expired Inherited From: Worker#event:tokenExpired tokenUpdated The Worker token has successfully updated Inherited From: Worker#event:tokenUpdated canceled The Task was canceled Parameters: Name Type Description task Task The Task who was canceled completed The Task was completed Parameters: Name Type Description task Task The Task who was completed transferAttemptFailed An OutgoingTransfer attempt has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCanceled An OutgoingTransfer has been canceled for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCompleted An OutgoingTransfer has been competed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferFailed An OutgoingTransfer has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferInitiated An OutgoingTransfer has been initiated for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer updated The attributes of this Task was updated Parameters: Name Type Description task Task The Task whose attributes were updated wrapup The Task was wrapped up Parameters: Name Type Description task Task The Task who was wrapped up activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred ready Worker is ready to listen for events and take action reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation tokenExpired The Worker token has expired tokenUpdated The Worker token has successfully updated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global 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. This version of TaskRouter SDK can be used with Twilio Flex and TaskRouter standalone instances. 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. const TaskRouter = require(\"twilio-taskrouter\"); const Twilio = require(\"twilio\"); const AccessToken = Twilio.jwt.AccessToken; const TaskRouterGrant = AccessToken.TaskRouterGrant; const accountSid = \"\"; const signingKeySid = \"\"; const signingKeySecret = \"\"; const workspaceSid = \"\"; const workerSid = \"\"; const token = createAccessToken( accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid ); const alice = new TaskRouter.Worker(token); alice.on(\"ready\", (readyAlice) =&gt; { console.log(`Worker ${readyAlice.sid} is now ready for work`); }); alice.on(\"reservationCreated\", (reservation) =&gt; { console.log( `Reservation ${reservation.sid} has been created for ${alice.sid}` ); console.log(`Task attributes are: ${reservation.task.attributes}`); reservation.on(\"accepted\", (acceptedReservation) =&gt; { console.log(`Reservation ${acceptedReservation.sid} was accepted.`); }); reservation .accept() .then((acceptedReservation) =&gt; { console.log(`Reservation status is ${acceptedReservation.status}`); }) .catch((err) =&gt; { console.log(`Error: ${err}`); }); }); function createAccessToken( accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid ) { const taskRouterGrant = new TaskRouterGrant({ workerSid: workerSid, workspaceSid: workspaceSid, role: \"worker\", }); const accessToken = new AccessToken( accountSid, signingKeySid, signingKeySecret ); accessToken.addGrant(taskRouterGrant); accessToken.identity = \"alice\"; return accessToken.toJwt(); } 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 Test with Sample App See README.md Contributing Bug fixes welcome! If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial. × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Activity.html":{"id":"Activity.html","title":"Class: Activity","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Activity Activity An Activity represents a state that a Worker can be in (e.g. Idle, Offline, Busy, ...) new Activity(worker, descriptor) Parameters: Name Type Description worker Worker The Worker descriptor ActivityDescriptor The ActivityDescriptor of this Activity Properties: Name Type Description accountSid string The sid of the Twilio account available boolean If the Worker can handle Tasks in this state dateCreated Date The date this Activity was created dateUpdated Date The date this Activity was last updated isCurrent boolean If this particular Activity represents the current state of the Worker name string The friendly name of this Activity sid string The sid of this Activity workspaceSid string The sid of the Workspace owning this Activity Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; available :boolean Type: boolean &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date isCurrent &lt;readonly&gt; name :string Type: string &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Methods setAsCurrent( [options]) Make this Activity the current state of the Worker Parameters: Name Type Argument Description options ActivityUpdateOptions &lt;optional&gt; Returns: Rejected if the Worker's activity state could not be set Type Promise.&lt;this&gt; × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Channel.html":{"id":"Channel.html","title":"Class: Channel","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Channel Channel A Channel distinguishes Tasks into specific types (e.g. Default, Chat, SMS, Video, Voice) new Channel(worker, request, descriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request descriptor WorkerChannelDescriptor The data descriptor which describes this Channel Properties: Name Type Description accountSid string The sid of the Twilio account assignedTasks number The number of Tasks assigned to this Channel available boolean If the Worker should be assigned Tasks of this Channel type availableCapacityPercentage number The current available capacity of this Worker to handle Tasks of this Channel type capacity number The number of Tasks that a Worker can handle of this Channel type lastReservedTime Date The date when the Channel last saw a Task dateCreated Date The date this Channel was created dateUpdated Date The date this Channel was last updated sid string The sid of this Activity taskChannelSid string The sid of the TaskChannel associated to this Worker Channel taskChannelUniqueName string The friendly name of this Channel workerSid string The sid of the Worker owning this Channel workspaceSid string The sid of the Workspace owning this Activity Fires: Channel#event:capacityUpdated Channel#event:availabilityUpdated Extends EventEmitter Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; assignedTasks :number Type: number &lt;readonly&gt; available :boolean Type: boolean &lt;readonly&gt; availableCapacityPercentage :number Type: number &lt;readonly&gt; capacity :number Type: number &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; lastReservedTime :Date Type: Date &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; taskChannelSid :string Type: string &lt;readonly&gt; taskChannelUniqueName :string Type: string &lt;readonly&gt; workerSid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Events availabilityUpdated The availability of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose availability was updated capacityUpdated The capacity of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose capacity was updated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"IncomingTransfer.html":{"id":"IncomingTransfer.html","title":"Class: IncomingTransfer","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: IncomingTransfer IncomingTransfer An IncomingTransfer represents the transfer of work for the Worker via another Worker or queue new IncomingTransfer(worker, transferDescriptor) Parameters: Name Type Description worker Worker The Worker transferDescriptor TransferDescriptor The transfer descriptor which describes this IncomingTransfer Properties: Name Type Argument Description dateCreated Date The timestamp when this Transfer was created dateUpdated Date The timestamp when this Transfer was last updated mode string Transfer mode ['WARM', 'COLD'] queueSid string The Sid of the TaskQueue the Task belongs to reservationSid string The Sid of the initiating Reservation. to string The sid of the Worker or TaskQueue this Transfer is intended for transferFailedReason string &lt;optional&gt; The reason, if applicable, for why a transfer failed type string The transfer type ['QUEUE', 'WORKER'] sid string The sid of this Transfer status string ['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED'] workerSid string The sid of the initiating Worker workflowSid string The Sid of the Workflow the Task was created against Extends Transfer × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"OutgoingTransfer.html":{"id":"OutgoingTransfer.html","title":"Class: OutgoingTransfer","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: OutgoingTransfer OutgoingTransfer An OutgoingTransfer represents the currently active outgoing transfer initiated by the Worker to another Worker or queue new OutgoingTransfer(worker, request, taskSid, transferDescriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request taskSid string The sid of the owning Task transferDescriptor TransferDescriptor The transfer descriptor which describes this OutgoingTransfer Properties: Name Type Argument Description dateCreated Date The timestamp when this Transfer was created dateUpdated Date The timestamp when this Transfer was last updated mode string Transfer mode ['WARM', 'COLD'] queueSid string The Sid of the TaskQueue the Task belongs to reservationSid string The Sid of the initiating Reservation. to string The sid of the Worker or TaskQueue this Transfer is intended for transferFailedReason string &lt;optional&gt; The reason, if applicable, for why a transfer failed type string The transfer type ['QUEUE', 'WORKER'] sid string The sid of this Transfer status string ['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED'] workerSid string The sid of the initiating Worker workflowSid string The Sid of the Workflow the Task was created against Extends Transfer Members taskSid :string taskSid Type: string Methods &lt;async&gt; cancel() Cancel the ongoing OutgoingTransfer Returns: Rejected if the OutgoingTransfer state could not be updated to 'canceled' Type Promise.&lt;this&gt; Events attemptFailed The attempt to transfer the Task to the desired entity failed Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that had an attempt failure canceled The Task's current OutgoingTransfer has successfully been cancelled Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was canceled completed The OutgoingTransfer has successfully been transferred to the desired entity Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was completed failed All attempts to transfer the Task to the desired entity have failed. No more attempts on the OutgoingTransfer will be made. Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that has failed × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Reservation.html":{"id":"Reservation.html","title":"Class: Reservation","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Reservation Reservation A Reservation correlates a Task and a Worker new Reservation(worker, request, descriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request descriptor ReservationDescriptor The data descriptor which describes this Reservation Properties: Name Type Argument Description accountSid string The sid of the Twilio account dateCreated Date The date the Reservation was created dateUpdated Date The date the Reservation was last updated canceledReasonCode number &lt;optional&gt; The reason code received when Reservation is canceled sid string The sid of the Reservation status string The current state of the Reservation. Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded', 'wrapping', 'completed']. task Task &lt;optional&gt; The Task tied to the Reservation transfer IncomingTransfer &lt;optional&gt; the IncomingTransfer tied to the Reservation timeout number The number of seconds until the Task times out workerSid string The sid of the Worker workspaceSid string The sid of the Workspace owning this Reservation version string The version of this Reservation Fires: Reservation#event:accepted Reservation#event:canceled Reservation#event:completed Reservation#event:rejected Reservation#event:rescinded Reservation#event:timeout Reservation#event:wrapup Extends EventEmitter Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; canceledReasonCode :number|undefined Type: number | undefined &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; status :\"pending\"|\"accepted\"|\"rejected\"|\"timeout\"|\"canceled\"|\"rescinded\"|\"wrapping\"|\"completed\" Type: \"pending\" | \"accepted\" | \"rejected\" | \"timeout\" | \"canceled\" | \"rescinded\" | \"wrapping\" | \"completed\" &lt;readonly&gt; task :Task|Object Type: Task | Object &lt;readonly&gt; timeout :number Type: number &lt;readonly&gt; transfer :IncomingTransfer|Object Type: IncomingTransfer | Object &lt;readonly&gt; version :string Type: string &lt;readonly&gt; workerSid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Methods accept() Accept the Reservation Returns: Rejected if unable to issue Accept instruction on the Reservation Type Promise.&lt;this&gt; call(from, url [, options]) Issue a Call to a Worker Parameters: Name Type Argument Description from string The caller id for the call to a Worker url string A valid TwiML URI that is executed on the answering Worker's leg options CallOptions &lt;optional&gt; Returns: Rejected if unable to issue Call instruction on the Reservation Type Promise.&lt;this&gt; complete() Complete the Reservation Returns: Rejected if unable to issue Complete instruction on the Reservation Type Promise.&lt;this&gt; conference( [options]) Conference the active Call tied to this Reservation to the Worker Parameters: Name Type Argument Description options ConferenceOptions &lt;optional&gt; Returns: Rejected if unable to issue Conference instruction on the link Reservation Type Promise.&lt;this&gt; dequeue( [options]) Dequeue the Reservation to the Worker. This will perform telephony to dequeue a Task that was enqueued using the Enqueue TwiML verb. A contact_uri must exist in the Worker's attributes for this call to go through. Parameters: Name Type Argument Description options DequeueOptions &lt;optional&gt; Returns: Rejected if unable to issue Dequeue instruction on the Reservation Type Promise.&lt;this&gt; fetchLatestVersion() Fetch the last version of this Reservation Returns: Type Promise.&lt;Reservation&gt; redirect(callSid, url [, options]) Redirect the active Call tied to this Reservation Parameters: Name Type Argument Description callSid string The sid of the Call to redirect url string A valid TwiML URI that is executed on the Caller's leg upon redirecting options RedirectOptions &lt;optional&gt; Returns: Rejected if unable to issue Redirect instruction on the Reservation Type Promise.&lt;this&gt; reject( [options]) Reject the Reservation Parameters: Name Type Argument Description options RejectOptions &lt;optional&gt; Returns: Rejected if unable to issue Reject instruction on the Reservation Type Promise.&lt;this&gt; updateParticipant(options) Update the Worker's leg in the Conference associated to this Reservation Parameters: Name Type Description options ReservationParticipantOptions Returns: Rejected if unable to update the Worker's leg in the Conference tied to the Reservation Type Promise.&lt;this&gt; wrap() Wrap the Reservation Returns: Rejected if unable to issue Wrap instruction on the Reservation Type Promise.&lt;this&gt; Events accepted Fired when a Reservation has been accepted for this Worker Parameters: Name Type Description reservation Reservation The accepted Reservation canceled Fired when a Reservation has been canceled for this Worker Parameters: Name Type Description reservation Reservation The canceled Reservation completed Fired when an accepted Reservation has been completed for this Worker Parameters: Name Type Description reservation Reservation The completed Reservation rejected Fired when a Reservation has been rejected for this Worker Parameters: Name Type Description reservation Reservation The rejected Reservation rescinded Fired when a Reservation has been rescinded for the Worker Parameters: Name Type Description reservation Reservation The rescinded Reservation timeout Fired when a Reservation has been timed out for this Worker Parameters: Name Type Description reservation Reservation The timed out Reservation wrapup Fired when a Reservation has been wrapped up for the Worker Parameters: Name Type Description reservation Reservation The wrapped up Reservation × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Supervisor.html":{"id":"Supervisor.html","title":"Class: Supervisor","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Supervisor Supervisor Create a Supervisor client representing a privileged TaskRouter Worker new Supervisor(token [, options]) Parameters: Name Type Argument Description token string The string token options WorkerOptions &lt;optional&gt; Fires: Supervisor#event:monitor Extends Worker Members &lt;readonly&gt; accountSid :string Type: string Inherited From: Worker#accountSid activities Inherited From: Worker#activities &lt;readonly&gt; activity Inherited From: Worker#activity &lt;readonly&gt; attributes :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; Inherited From: Worker#attributes channels Inherited From: Worker#channels &lt;readonly&gt; dateActivityChanged :Date Type: Date Inherited From: Worker#dateActivityChanged &lt;readonly&gt; dateCreated :Date Type: Date Inherited From: Worker#dateCreated &lt;readonly&gt; dateStatusChanged :Date Type: Date Inherited From: Worker#dateStatusChanged &lt;readonly&gt; dateUpdated :Date Type: Date Inherited From: Worker#dateUpdated &lt;readonly&gt; friendlyName :string Type: string Inherited From: Worker#friendlyName &lt;readonly&gt; name :string Type: string Inherited From: Worker#name reservations Inherited From: Worker#reservations &lt;readonly&gt; sid :string Type: string Inherited From: Worker#sid version :string Type: string Inherited From: Worker#version &lt;readonly&gt; workerActivitySid :string Type: string Inherited From: Worker#workerActivitySid &lt;readonly&gt; workerSid :string Type: string Inherited From: Worker#workerSid &lt;readonly&gt; workspaceSid :string Type: string Inherited From: Worker#workspaceSid Methods _bumpVersion() bumps the worker version Inherited From: Worker#_bumpVersion createTask(to, from, workflowSid, taskQueueSid [, options]) Create a Task Parameters: Name Type Argument Description to string The contact uri of the customer. Stored in the Task's attributes as \"outbound_to\" from string The contact uri of the Worker. Stored in the Task's attributes as \"from\" workflowSid string The Sid of the Workflow this Task should belong to taskQueueSid string The Sid of the TaskQueue this Task should belong to, used for reporting purposes only options WorkerTaskOptions &lt;optional&gt; Inherited From: Worker#createTask Returns: Rejected if unable to create a Task on behalf of the Worker. Returns the TaskSid of the created Task. Type Promise.&lt;string&gt; disconnect() Gracefully disconnect the client. Inherited From: Worker#disconnect Returns: Type void fetchLatestVersion() Fetch the last version of this Worker Inherited From: Worker#fetchLatestVersion Returns: Type Promise.&lt;this&gt; getLogger(prefix) Parameters: Name Type Description prefix string Inherited From: Worker#getLogger Returns: Type Logger getRoutes() Inherited From: Worker#getRoutes Returns: Type Routes monitor(taskSid, reservationSid [, extraParams]) Add this Supervisor to an ongoing Reservation by Sid. Parameters: Name Type Argument Description taskSid string The sid of the Task to add a monitor to. reservationSid string The sid of the Reservation to add a monitor to. extraParams Record.&lt;any, any&gt; &lt;optional&gt; An object containing extra params to append to the payload. Returns: Promise setAttributes(attributes) Update attributes Parameters: Name Type Description attributes Record.&lt;any, any&gt; A JSON describing the Worker's attributes Inherited From: Worker#setAttributes Returns: Rejected if the attributes cannot be set Type Promise.&lt;this&gt; updateToken(newToken) Update token Parameters: Name Type Description newToken string The new token that should be used for authentication Inherited From: Worker#updateToken Returns: Emits error if unable to update token Type void Events activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:activityUpdated attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:attributesUpdated disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected Inherited From: Worker#event:disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred Inherited From: Worker#event:error monitor Add this Supervisor to an ongoing Reservation by Sid. Parameters: Name Type Argument Description taskSid string The sid of the Task to add a monitor to. reservationSid string The sid of the Reservation to add a monitor to. extraParams Object &lt;optional&gt; An object containing extra params to append to the payload. ready Worker is ready to listen for events and take action Inherited From: Worker#event:ready reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation Inherited From: Worker#event:reservationCreated reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation Inherited From: Worker#event:reservationFailed tokenExpired The Worker token has expired Inherited From: Worker#event:tokenExpired tokenUpdated The Worker token has successfully updated Inherited From: Worker#event:tokenUpdated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Task.html":{"id":"Task.html","title":"Class: Task","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Task Task A Task represents an item of work new Task(worker, request, reservationSid, descriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request reservationSid string The SID of the Reservation associated with this Task descriptor TaskDescriptor The data descriptor which describes this Task Properties: Name Type Description addOns Record.&lt;any, any&gt; The addons attached to the Task age number The age of the Task in seconds attributes Record.&lt;any, any&gt; The attributes of the Task dateCreated Date The date the Task was created dateUpdated Date The date the Task was last updated priority number The priority of the Task queueName string The friendly name of the TaskQueue the Task is currently in queueSid string The sid of the TaskQueue the Task is currently in reason string The reason the Task was completed or canceled, if applicable routingTarget string The target Sid of the Worker, TaskQueue, or Workflow this Task will be routed to. sid string The sid of the Task status string The status of the Task. Options: ['pending', 'reserved', 'assigned', 'canceled', 'completed', 'wrapping'] taskChannelSid string The sid of the Task Channel associated to the Task in MultiTask mode taskChannelUniqueName string The unique name of the Task Channel associated to the Task in MultiTask mode timeout number The number of seconds the Task is allowed to live transfers Transfers The IncomingTransfer and OutgoingTransfer related to this Task, if applicable workflowName string The name of the Workflow responsible for routing the Task workflowSid string The sid of the Workflow responsible for routing the Task version string The version of this Task reservationSid string The sid of Reservation virtualStartTime Date Optionally set starting time of the Task, in cases where the interaction between the customer and agents spans across multiple tasks. If not provided, defaults to dateCreated. Fires: Task#event:canceled Task#event:completed Task#event:transferAttemptFailed Task#event:transferCanceled Task#event:transferCompleted Task#event:transferFailed Task#event:transferInitiated Task#event:updated Task#event:wrapup Extends EventEmitter Members &lt;readonly&gt; addOns :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; &lt;readonly&gt; age :number Type: number &lt;readonly&gt; attributes :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; priority :number Type: number &lt;readonly&gt; queueName :string Type: string &lt;readonly&gt; queueSid :string Type: string &lt;readonly&gt; reason :string Type: string &lt;readonly&gt; reservationSid :string Type: string &lt;readonly&gt; routingTarget :string Type: string &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; status :'pending'|'reserved'|'assigned'|'canceled'|'completed'|'wrapping' Type: 'pending' | 'reserved' | 'assigned' | 'canceled' | 'completed' | 'wrapping' &lt;readonly&gt; taskChannelSid :string Type: string &lt;readonly&gt; taskChannelUniqueName :string Type: string &lt;readonly&gt; timeout :number Type: number &lt;readonly&gt; transfers :Transfers Type: Transfers &lt;readonly&gt; version :string Type: string &lt;readonly&gt; virtualStartTime :Date Type: Date &lt;readonly&gt; workflowName :string Type: string &lt;readonly&gt; workflowSid :string Type: string Methods complete(reason) Update the Task status to 'completed' Parameters: Name Type Description reason string The reason for completing the Task Returns: Rejected if the Task state could not be updated to 'completed' Type Promise.&lt;this&gt; fetchLatestVersion() Fetch the last version of this Task Returns: Type Promise.&lt;Task&gt; hold(targetWorkerSid, onHold, options) Hold the worker's call leg in the Conference associated to this Task and specified TargetWorkerSid Parameters: Name Type Description targetWorkerSid String The target worker's sid which should be put onhold or unhold onHold boolean Whether to hold or unhold the specified worker's call leg in the Conference referenced by the Task options TaskHoldOptions Returns: Type Promise.&lt;this&gt; kick(workerSid) Kick another active Worker participant from the ongoing conference Parameters: Name Type Description workerSid string The Sid of the Worker who is currently in the conference that should be kicked Returns: Rejected if unable to kick the call leg of the targeted Worker in the Conference tied to the Task Type Promise.&lt;this&gt; setAttributes(attributes) Update the Task attributes to the given attributes. Parameters: Name Type Description attributes Record.&lt;any, any&gt; A JSON to update the attributes. Returns: Rejected if the attributes cannot be set Type Promise.&lt;this&gt; setVirtualStartTime(date) Set virtual start time of the Task. Parameters: Name Type Description date Date Virtual start time as a Date. Returns: Rejected if fails to set the time. Type Promise.&lt;this&gt; &lt;async&gt; transfer(to [, options]) Transfer the Task to another entity. Parameters: Name Type Argument Description to string The Worker or TaskQueue entity sid to transfer the task to. options TransferOptions &lt;optional&gt; Returns: Type Promise.&lt;this&gt; updateParticipant(options) Update the Customer leg in the Conference associated to this Task Parameters: Name Type Description options TaskParticipantOptions Returns: Rejected if unable to update the Customers' leg in the Conference tied to the Task Type Promise.&lt;this&gt; wrapUp(options) Update the Task status to 'wrapping' in a multi-task enabled Workspace Parameters: Name Type Description options WrappingOptions Returns: Rejected if the Task state could not be updated to 'wrapping' Type Promise.&lt;this&gt; Events canceled The Task was canceled Parameters: Name Type Description task Task The Task who was canceled completed The Task was completed Parameters: Name Type Description task Task The Task who was completed transferAttemptFailed An OutgoingTransfer attempt has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCanceled An OutgoingTransfer has been canceled for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCompleted An OutgoingTransfer has been competed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferFailed An OutgoingTransfer has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferInitiated An OutgoingTransfer has been initiated for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer updated The attributes of this Task was updated Parameters: Name Type Description task Task The Task whose attributes were updated wrapup The Task was wrapped up Parameters: Name Type Description task Task The Task who was wrapped up × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"TaskQueue.html":{"id":"TaskQueue.html","title":"Class: TaskQueue","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: TaskQueue TaskQueue A TaskQueue represents a set of Tasks awaiting assignment. new TaskQueue(descriptor) Parameters: Name Type Description descriptor TaskQueueDescriptor The TaskQueueDescriptor of this TaskQueue Properties: Name Type Description sid string The Sid of the TaskQueue queueSid string The Sid of the TaskQueue accountSid string The Sid of the owning Account of the TaskQueue} workspaceSid string The Sid of the Workspace the TaskQueue belongs to name string The friendly name of the TaskQueue queueName string The friendly name of the TaskQueue assignmentActivityName string The Activity name for the reservation of the TaskQueue reservationActivityName string The Activity name for the assignment of the TaskQueue assignmentActivitySid string The Sid of the assignment Activity for the TaskQueue reservationActivitySid string The Sid of the reservation Activity for the TaskQueue targetWorkers string The expression used to target workers maxReservedWorkers number The maximum number of reserved workers for the TaskQueue taskOrder string The task order for the TaskQueue FIFO or LIFO dateCreated Date The date when the TaskQueue was created dateUpdated Date The date when the TaskQueue was last updated Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; assignmentActivityName :string Type: string &lt;readonly&gt; assignmentActivitySid :string Type: string &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; maxReservedWorkers :number Type: number &lt;readonly&gt; name :string Type: string &lt;readonly&gt; queueName :string Type: string &lt;readonly&gt; queueSid :string Type: string &lt;readonly&gt; reservationActivityName :string Type: string &lt;readonly&gt; reservationActivitySid :string Type: string &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; targetWorkers :string Type: string &lt;readonly&gt; taskOrder :string Type: string &lt;readonly&gt; workspaceSid :string Type: string × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Transfers.html":{"id":"Transfers.html","title":"Class: Transfers","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Transfers Transfers Transfers contains both the IncomingTransfer and OutgoingTransfer for the Worker new Transfers(worker, request, taskDescriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request taskDescriptor TaskDescriptor The task descriptor which describes the related Task Properties: Name Type Description incoming IncomingTransfer The IncomingTransfer for the Worker if the related Reservation was initiated via transfer by another agent outgoing OutgoingTransfer The current active (initiated but not yet finished) OutgoingTransfer initiated by the Worker to another agent or queue Extends EventEmitter Members incoming :IncomingTransfer Type: IncomingTransfer outgoing :OutgoingTransfer Type: OutgoingTransfer Methods _emitEvent(eventType, rawEventData) Emit the transfer event and handle any appropriate clean-up or data modification Parameters: Name Type Description eventType Object the name of the transfer event rawEventData Object the raw payload contents of the event _update(latestTransfersData) Update Transfers using the latest transfers data Parameters: Name Type Description latestTransfersData Object The latest transfers data × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Worker.html":{"id":"Worker.html","title":"Class: Worker","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Worker Worker Create a Worker client representing a TaskRouter Worker new Worker(token [, options] [, deps]) Parameters: Name Type Argument Description token string The string token options WorkerOptions &lt;optional&gt; deps WorkerDeps &lt;optional&gt; Properties: Name Type Description accountSid string The sid of the Twilio account activities Map.&lt;string, Activity&gt; The list of possible states a Worker can be activity Activity The current Activity of the Worker activitySid string The sid of the Activity the Worker is currently in activityName string The current Activity name the Worker is currently in attributes Record.&lt;any, any&gt; A JSON representation of the Worker's attributes available boolean Whether or not the Worker is available to take on Tasks channels Map.&lt;string, Channel&gt; The list of available Channels connectActivitySid string The Activity to set the Worker as on connect dateCreated Date The date this Worker was created dateStatusChanged Date The date this Worker's activity was last changed dateUpdated Date The date this Worker was last updated name string The friendly name of the Worker reservations Map.&lt;string, Reservation&gt; A list of pending Reservations for the Worker sid string The sid of the Worker workspaceSid string The sid of the Workspace owning this Worker workerSid string The sid of the Worker, duplicates sid field for backwards compatibility workerActivitySid string The sid of the Activity the Worker is currently in, duplicates activitySid field for backwards compatibility dateActivityChanged Date The date when the Worker's state was last changed, duplicates dateStatusChanged field for backwards compatibility friendlyName string The friendly name of the Worker, duplicates name field for backwards compatibility version string The version of this Worker Fires: Worker#event:activityUpdated Worker#event:attributesUpdated Worker#event:disconnected Worker#event:error Worker#event:ready Worker#event:reservationCreated Worker#event:reservationFailed Worker#event:tokenExpired Worker#event:tokenUpdated Extends EventEmitter Members &lt;readonly&gt; accountSid :string Type: string activities &lt;readonly&gt; activity &lt;readonly&gt; attributes :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; channels &lt;readonly&gt; dateActivityChanged :Date Type: Date &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateStatusChanged :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; friendlyName :string Type: string &lt;readonly&gt; name :string Type: string reservations &lt;readonly&gt; sid :string Type: string version :string Type: string &lt;readonly&gt; workerActivitySid :string Type: string &lt;readonly&gt; workerSid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Methods _bumpVersion() bumps the worker version createTask(to, from, workflowSid, taskQueueSid [, options]) Create a Task Parameters: Name Type Argument Description to string The contact uri of the customer. Stored in the Task's attributes as \"outbound_to\" from string The contact uri of the Worker. Stored in the Task's attributes as \"from\" workflowSid string The Sid of the Workflow this Task should belong to taskQueueSid string The Sid of the TaskQueue this Task should belong to, used for reporting purposes only options WorkerTaskOptions &lt;optional&gt; Returns: Rejected if unable to create a Task on behalf of the Worker. Returns the TaskSid of the created Task. Type Promise.&lt;string&gt; disconnect() Gracefully disconnect the client. Returns: Type void fetchLatestVersion() Fetch the last version of this Worker Returns: Type Promise.&lt;this&gt; getLogger(prefix) Parameters: Name Type Description prefix string Returns: Type Logger getRoutes() Returns: Type Routes setAttributes(attributes) Update attributes Parameters: Name Type Description attributes Record.&lt;any, any&gt; A JSON describing the Worker's attributes Returns: Rejected if the attributes cannot be set Type Promise.&lt;this&gt; updateToken(newToken) Update token Parameters: Name Type Description newToken string The new token that should be used for authentication Returns: Emits error if unable to update token Type void Events activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred ready Worker is ready to listen for events and take action reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation tokenExpired The Worker token has expired tokenUpdated The Worker token has successfully updated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "},"Workspace.html":{"id":"Workspace.html","title":"Class: Workspace","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Workspace Workspace Create a Workspace client representing a TaskRouter Workspace new Workspace(jwt [, options] [, workspaceSid]) Parameters: Name Type Argument Description jwt string The string token options WorkspaceOptions &lt;optional&gt; workspaceSid string &lt;optional&gt; Sid of this Workspace, has to be provided if JWE token is passed Throws: Exception if workspaceSid is not passed with JWE token Members &lt;readonly&gt; workspaceSid :string Type: string workspaceSid :string Type: string Methods fetchTaskQueue(queueSid) Fetch task queue of this Workspace by given sid Parameters: Name Type Description queueSid string the sid of the task queue to fetch Returns: fetchTaskQueues( [params]) Fetch task queues of this Workspace Parameters: Name Type Argument Description params FetchTaskQueuesParams &lt;optional&gt; Returns: fetchWorker(workerSid) Fetch worker of this Workspace by given sid Parameters: Name Type Description workerSid string the sid of the worker to fetch Returns: fetchWorkers( [params]) Fetch workers of this Workspace Parameters: Name Type Argument Description params FetchWorkersParams &lt;optional&gt; Returns: updateToken(newToken) Update token Parameters: Name Type Description newToken string The new token that should be used for authentication Returns: throws error if unable to update token Type void × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-01-30T13:14:08+00:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Global Type Definitions ActivityUpdateOptions Type: Object Properties: Name Type Argument Default Description rejectPendingReservations boolean &lt;optional&gt; false Represents whether all pending reservations should be rejected with the update to an unavailable Activity. CallOptions Type: Object Properties: Name Type Argument Default Description accept boolean &lt;optional&gt; false Represents whether the Task should be accepted before initiating the call record string &lt;optional&gt; 'do-not-record' To record the call or not statusCallbackUrl string &lt;optional&gt; null A valid status status callback url to string &lt;optional&gt; null The number or endpoint that should be called. If not provided, the contact_uri defined in the Worker attributes will be used timeout number &lt;optional&gt; 60 The integer number of seconds Twilio should allow the phone associated to \"contact_uri\" to ring ConferenceOptions Type: Object Properties: Name Type Argument Default Description to string &lt;optional&gt; null The contact uri of the Worker; can be a phone number or a client ID. Required, if no contact_uri on the Worker's attributes. from string &lt;optional&gt; null The caller id for the call to the Worker. Must be a verified Twilio number. timeout number &lt;optional&gt; 60 The integer number of seconds that Twilio should allow the call to ring before assuming there is no answer. statusCallback string &lt;optional&gt; null The URL endpoint to receive call status events of the Worker leg. statusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method for the Status Callback URL. statusCallbackEvent string &lt;optional&gt; 'completed' A comma separated list of events to subscribe to. The possible list of events are: ['initiated', 'ringing', 'answered', 'completed']. record string &lt;optional&gt; 'do-not-record' Whether to record the Worker leg of the Conference. muted boolean &lt;optional&gt; false Whether the Worker leg of the Conference is muted. beep string | boolean &lt;optional&gt; true Whether the Worker leg should be when entering the Conference. The options for beep are: [true, false, 'onEnter', 'onExit']. startConferenceOnEnter boolean &lt;optional&gt; true Whether the Conference should start when the Worker leg enters. endConferenceOnExit boolean &lt;optional&gt; false Whether the Conference should end when the Worker leg exits. endConferenceOnCustomerExit boolean &lt;optional&gt; false Whether the Conference should end when the customer leg exits. beepOnCustomerEntrance boolean &lt;optional&gt; true Whether the Conference should beep when the customer leg enters. waitUrl string &lt;optional&gt; default Twilio hold music The URL endpoint to play when waiting for the Conference to begin. waitMethod string &lt;optional&gt; 'POST' The HTTP method for the Wait URL. earlyMedia boolean &lt;optional&gt; true Whether Twilio should feed early media to be played directly into a Conference. maxParticipants number &lt;optional&gt; 10 The number of max participants allowed in a Conference. conferenceStatusCallback string &lt;optional&gt; null The URL endpoint to receive Conference status events. conferenceStatusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method for the Conference Status Callback URL. conferenceStatusCallbackEvent string &lt;optional&gt; 'start,end' A comma separated list of Conference events to subscribe to. The possible list of events are: ['start', 'end', 'join', 'leave', 'mute', 'hold', 'speaker']. conferenceRecord string | boolean &lt;optional&gt; false Whether the entire Conference should be recorded. The possible options for conferenceRecord are: [true, false, 'record-from-start', 'do-not-record']. conferenceTrim string &lt;optional&gt; 'trim-silence' Whether to trim the Conference recording. The options for conferenceTrim are: ['trim-silence', 'do-not-trim']. recordingChannels string &lt;optional&gt; 'mono' Which channel of the Conference to record. The options are: ['mono', 'dual']. recordingStatusCallback string &lt;optional&gt; null The URL endpoint to receive recording status events. recordingStatusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method for the Recording Status Callback URL. conferenceRecordingStatusCallback string &lt;optional&gt; null The URl endpoint to receive Conference events. conferenceRecordingStatusCallbackMethod string &lt;optional&gt; 'POST' The HTTP method of the Conference Recording Status Callback. region string &lt;optional&gt; null The specific region. The options for region are: ['us1', 'ie1', 'sg1', 'br1', 'au1', 'jp1']. sipAuthUsername string &lt;optional&gt; null The SIP auth username to use. sipAuthPassword string &lt;optional&gt; null The SIP auth password to use. transcribe boolean &lt;optional&gt; false Whether the call recording should be transcribed or not. transcriptionConfiguration string &lt;optional&gt; null The SID or (unique) friendly name of the transcription configuration object to use. DequeueOptions Type: Object Properties: Name Type Argument Default Description from string &lt;optional&gt; null The caller id for the call to the Worker. Must be a verified Twilio number. to string &lt;optional&gt; null The contact uri of the Worker; can be a phone number or a client ID. Required, if no contact_uri on the Worker's attributes. postWorkActivitySid string &lt;optional&gt; null The activitySid to update the Worker to after dequeuing the Reservation. record string &lt;optional&gt; 'do-not-record' Defines which legs of the call should be recorded. timeout number &lt;optional&gt; 60 The integer number of seconds that Twilio should allow the call to ring before assuming there is no answer. statusCallbackUrl string &lt;optional&gt; null A URL that Twilio will send asynchronous webhook this._request. to on a completed call event. statusCallbackEvents string &lt;optional&gt; null A comma separated string of the events to subscribe to FetchTaskQueuesParams Type: Object Properties: Name Type Argument Description AfterSid string &lt;optional&gt; FriendlyName string &lt;optional&gt; Ordering \"DateUpdated:asc\" | \"DateUpdated:desc\" &lt;optional&gt; WorkerSid string &lt;optional&gt; FetchWorkersParams Type: Object Properties: Name Type Argument Description AfterSid string &lt;optional&gt; FriendlyName string &lt;optional&gt; ActivitySid string &lt;optional&gt; ActivityName string &lt;optional&gt; TargetWorkersExpression string &lt;optional&gt; Ordering \"DateStatusChanged:asc\" | \"DateStatusChanged:desc\" &lt;optional&gt; MaxWorkers number &lt;optional&gt; RedirectOptions Type: Object Properties: Name Type Argument Default Description accept boolean &lt;optional&gt; false Represents whether the Task should be accepted before initiating the call RejectOptions Type: Object Properties: Name Type Description activitySid string The sid of the Activity to update the worker to upon rejecting the Reservation ReservationParticipantOptions Type: Object Properties: Name Type Description endConferenceOnExit boolean Whether the Conference should end when this Worker participant leaves the Conference mute boolean Mute or unmute this Worker participant beepOnExit boolean Whether there should be a beep sound when this Worker participant leaves the Conference TaskHoldOptions Type: Object Properties: Name Type Argument Description holdUrl string &lt;optional&gt; The URL endpoint to play when participant is on hold. holdMethod 'GET' &lt;optional&gt; The HTTP method for the hold URL. TaskParticipantOptions Type: Object Properties: Name Type Description hold boolean Whether to hold the customer leg of the Conference referenced by the Task holdUrl string The URL endpoint to play when participant is on hold. holdMethod 'GET' The HTTP method for the hold URL. TransferOptions Type: Object Properties: Name Type Default Description attributes Record.&lt;any, any&gt; Updated attributes for the task mode 'WARM' | 'COLD' 'WARM' 'WARM' or 'COLD' priority number Updated priority for the task WorkerDeps Type: Object Properties: Name Type Description Request Request EventBridgeSignaling EventBridgeSignaling WorkerOptions Type: Object Properties: Name Type Argument Default Description connectActivitySid string &lt;optional&gt; '' The Activity state of the Worker upon connect closeExistingSessions boolean &lt;optional&gt; false Whether other open sessions of this Worker should be terminated logLevel string &lt;optional&gt; 'error' The level of logging to enable ['error', 'warn', 'info', 'debug', 'trace', 'silent'] region string &lt;optional&gt; the realm for connections (ex. \"stage-us1\") WorkerTaskOptions Type: Object Properties: Name Type Argument Default Description attributes Record.&lt;any, any&gt; &lt;optional&gt; null Additional attributes for the Task taskChannelUniqueName string &lt;optional&gt; null The friendly name of the Channel this Task belongs to. If not provided, defaults to 'default' channel. taskChannelSid string &lt;optional&gt; null The Sid of the Channel this Task belongs to. If not provided, defaults to 'default' channel. virtualStartTime Date &lt;optional&gt; null Optional manually set starting time of the Task, in cases where the interaction between the customer and agents spans across multiple tasks. If not provided, defaults to dateCreated. WorkspaceOptions Type: Object Properties: Name Type Argument Default Description region string &lt;optional&gt; the realm for connections (ex. \"stage-us1\") pageSize number &lt;optional&gt; The number of items returned in each request logLevel string &lt;optional&gt; 'error' The level of logging to enable ['error', 'warn', 'info', 'debug', 'trace', 'silent'] WrappingOptions Type: Object Properties: Name Type Default Description reason string null The reason for wrapping up the Task × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Classes Classes Activity Channel IncomingTransfer OutgoingTransfer Reservation Supervisor Task TaskQueue Transfers Worker Workspace Events availabilityUpdated The availability of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose availability was updated capacityUpdated The capacity of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose capacity was updated attemptFailed The attempt to transfer the Task to the desired entity failed Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that had an attempt failure canceled The Task's current OutgoingTransfer has successfully been cancelled Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was canceled completed The OutgoingTransfer has successfully been transferred to the desired entity Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was completed failed All attempts to transfer the Task to the desired entity have failed. No more attempts on the OutgoingTransfer will be made. Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that has failed accepted Fired when a Reservation has been accepted for this Worker Parameters: Name Type Description reservation Reservation The accepted Reservation canceled Fired when a Reservation has been canceled for this Worker Parameters: Name Type Description reservation Reservation The canceled Reservation completed Fired when an accepted Reservation has been completed for this Worker Parameters: Name Type Description reservation Reservation The completed Reservation rejected Fired when a Reservation has been rejected for this Worker Parameters: Name Type Description reservation Reservation The rejected Reservation rescinded Fired when a Reservation has been rescinded for the Worker Parameters: Name Type Description reservation Reservation The rescinded Reservation timeout Fired when a Reservation has been timed out for this Worker Parameters: Name Type Description reservation Reservation The timed out Reservation wrapup Fired when a Reservation has been wrapped up for the Worker Parameters: Name Type Description reservation Reservation The wrapped up Reservation activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:activityUpdated attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:attributesUpdated disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected Inherited From: Worker#event:disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred Inherited From: Worker#event:error monitor Add this Supervisor to an ongoing Reservation by Sid. Parameters: Name Type Argument Description taskSid string The sid of the Task to add a monitor to. reservationSid string The sid of the Reservation to add a monitor to. extraParams Object &lt;optional&gt; An object containing extra params to append to the payload. ready Worker is ready to listen for events and take action Inherited From: Worker#event:ready reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation Inherited From: Worker#event:reservationCreated reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation Inherited From: Worker#event:reservationFailed tokenExpired The Worker token has expired Inherited From: Worker#event:tokenExpired tokenUpdated The Worker token has successfully updated Inherited From: Worker#event:tokenUpdated canceled The Task was canceled Parameters: Name Type Description task Task The Task who was canceled completed The Task was completed Parameters: Name Type Description task Task The Task who was completed transferAttemptFailed An OutgoingTransfer attempt has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCanceled An OutgoingTransfer has been canceled for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCompleted An OutgoingTransfer has been competed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferFailed An OutgoingTransfer has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferInitiated An OutgoingTransfer has been initiated for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer updated The attributes of this Task was updated Parameters: Name Type Description task Task The Task whose attributes were updated wrapup The Task was wrapped up Parameters: Name Type Description task Task The Task who was wrapped up activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred ready Worker is ready to listen for events and take action reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation tokenExpired The Worker token has expired tokenUpdated The Worker token has successfully updated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global 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. This version of TaskRouter SDK can be used with Twilio Flex and TaskRouter standalone instances. 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. const TaskRouter = require(\"twilio-taskrouter\"); const Twilio = require(\"twilio\"); const AccessToken = Twilio.jwt.AccessToken; const TaskRouterGrant = AccessToken.TaskRouterGrant; const accountSid = \"\"; const signingKeySid = \"\"; const signingKeySecret = \"\"; const workspaceSid = \"\"; const workerSid = \"\"; const token = createAccessToken( accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid ); const alice = new TaskRouter.Worker(token); alice.on(\"ready\", (readyAlice) =&gt; { console.log(`Worker ${readyAlice.sid} is now ready for work`); }); alice.on(\"reservationCreated\", (reservation) =&gt; { console.log( `Reservation ${reservation.sid} has been created for ${alice.sid}` ); console.log(`Task attributes are: ${reservation.task.attributes}`); reservation.on(\"accepted\", (acceptedReservation) =&gt; { console.log(`Reservation ${acceptedReservation.sid} was accepted.`); }); reservation .accept() .then((acceptedReservation) =&gt; { console.log(`Reservation status is ${acceptedReservation.status}`); }) .catch((err) =&gt; { console.log(`Error: ${err}`); }); }); function createAccessToken( accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid ) { const taskRouterGrant = new TaskRouterGrant({ workerSid: workerSid, workspaceSid: workspaceSid, role: \"worker\", }); const accessToken = new AccessToken( accountSid, signingKeySid, signingKeySecret ); accessToken.addGrant(taskRouterGrant); accessToken.identity = \"alice\"; return accessToken.toJwt(); } 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 Test with Sample App See README.md Contributing Bug fixes welcome! If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial. × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Activity.html":{"id":"Activity.html","title":"Class: Activity","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Activity Activity An Activity represents a state that a Worker can be in (e.g. Idle, Offline, Busy, ...) new Activity(worker, descriptor) Parameters: Name Type Description worker Worker The Worker descriptor ActivityDescriptor The ActivityDescriptor of this Activity Properties: Name Type Description accountSid string The sid of the Twilio account available boolean If the Worker can handle Tasks in this state dateCreated Date The date this Activity was created dateUpdated Date The date this Activity was last updated isCurrent boolean If this particular Activity represents the current state of the Worker name string The friendly name of this Activity sid string The sid of this Activity workspaceSid string The sid of the Workspace owning this Activity Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; available :boolean Type: boolean &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date isCurrent &lt;readonly&gt; name :string Type: string &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Methods setAsCurrent( [options]) Make this Activity the current state of the Worker Parameters: Name Type Argument Description options ActivityUpdateOptions &lt;optional&gt; Returns: Rejected if the Worker's activity state could not be set Type Promise.&lt;this&gt; × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Channel.html":{"id":"Channel.html","title":"Class: Channel","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Channel Channel A Channel distinguishes Tasks into specific types (e.g. Default, Chat, SMS, Video, Voice) new Channel(worker, request, descriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request descriptor WorkerChannelDescriptor The data descriptor which describes this Channel Properties: Name Type Description accountSid string The sid of the Twilio account assignedTasks number The number of Tasks assigned to this Channel available boolean If the Worker should be assigned Tasks of this Channel type availableCapacityPercentage number The current available capacity of this Worker to handle Tasks of this Channel type capacity number The number of Tasks that a Worker can handle of this Channel type lastReservedTime Date The date when the Channel last saw a Task dateCreated Date The date this Channel was created dateUpdated Date The date this Channel was last updated sid string The sid of this Activity taskChannelSid string The sid of the TaskChannel associated to this Worker Channel taskChannelUniqueName string The friendly name of this Channel workerSid string The sid of the Worker owning this Channel workspaceSid string The sid of the Workspace owning this Activity Fires: Channel#event:capacityUpdated Channel#event:availabilityUpdated Extends EventEmitter Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; assignedTasks :number Type: number &lt;readonly&gt; available :boolean Type: boolean &lt;readonly&gt; availableCapacityPercentage :number Type: number &lt;readonly&gt; capacity :number Type: number &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; lastReservedTime :Date Type: Date &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; taskChannelSid :string Type: string &lt;readonly&gt; taskChannelUniqueName :string Type: string &lt;readonly&gt; workerSid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Events availabilityUpdated The availability of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose availability was updated capacityUpdated The capacity of this Channel was updated Parameters: Name Type Description channel Channel The Channel whose capacity was updated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"IncomingTransfer.html":{"id":"IncomingTransfer.html","title":"Class: IncomingTransfer","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: IncomingTransfer IncomingTransfer An IncomingTransfer represents the transfer of work for the Worker via another Worker or queue new IncomingTransfer(worker, transferDescriptor) Parameters: Name Type Description worker Worker The Worker transferDescriptor TransferDescriptor The transfer descriptor which describes this IncomingTransfer Properties: Name Type Argument Description dateCreated Date The timestamp when this Transfer was created dateUpdated Date The timestamp when this Transfer was last updated mode string Transfer mode ['WARM', 'COLD'] queueSid string The Sid of the TaskQueue the Task belongs to reservationSid string The Sid of the initiating Reservation. to string The sid of the Worker or TaskQueue this Transfer is intended for transferFailedReason string &lt;optional&gt; The reason, if applicable, for why a transfer failed type string The transfer type ['QUEUE', 'WORKER'] sid string The sid of this Transfer status string ['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED'] workerSid string The sid of the initiating Worker workflowSid string The Sid of the Workflow the Task was created against Extends Transfer × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"OutgoingTransfer.html":{"id":"OutgoingTransfer.html","title":"Class: OutgoingTransfer","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: OutgoingTransfer OutgoingTransfer An OutgoingTransfer represents the currently active outgoing transfer initiated by the Worker to another Worker or queue new OutgoingTransfer(worker, request, taskSid, transferDescriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request taskSid string The sid of the owning Task transferDescriptor TransferDescriptor The transfer descriptor which describes this OutgoingTransfer Properties: Name Type Argument Description dateCreated Date The timestamp when this Transfer was created dateUpdated Date The timestamp when this Transfer was last updated mode string Transfer mode ['WARM', 'COLD'] queueSid string The Sid of the TaskQueue the Task belongs to reservationSid string The Sid of the initiating Reservation. to string The sid of the Worker or TaskQueue this Transfer is intended for transferFailedReason string &lt;optional&gt; The reason, if applicable, for why a transfer failed type string The transfer type ['QUEUE', 'WORKER'] sid string The sid of this Transfer status string ['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED'] workerSid string The sid of the initiating Worker workflowSid string The Sid of the Workflow the Task was created against Extends Transfer Members taskSid :string taskSid Type: string Methods &lt;async&gt; cancel() Cancel the ongoing OutgoingTransfer Returns: Rejected if the OutgoingTransfer state could not be updated to 'canceled' Type Promise.&lt;this&gt; Events attemptFailed The attempt to transfer the Task to the desired entity failed Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that had an attempt failure canceled The Task's current OutgoingTransfer has successfully been cancelled Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was canceled completed The OutgoingTransfer has successfully been transferred to the desired entity Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that was completed failed All attempts to transfer the Task to the desired entity have failed. No more attempts on the OutgoingTransfer will be made. Parameters: Name Type Description outgoingTransfer OutgoingTransfer The OutgoingTransfer that has failed × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Reservation.html":{"id":"Reservation.html","title":"Class: Reservation","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Reservation Reservation A Reservation correlates a Task and a Worker new Reservation(worker, request, descriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request descriptor ReservationDescriptor The data descriptor which describes this Reservation Properties: Name Type Argument Description accountSid string The sid of the Twilio account dateCreated Date The date the Reservation was created dateUpdated Date The date the Reservation was last updated canceledReasonCode number &lt;optional&gt; The reason code received when Reservation is canceled sid string The sid of the Reservation status string The current state of the Reservation. Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded', 'wrapping', 'completed']. task Task &lt;optional&gt; The Task tied to the Reservation transfer IncomingTransfer &lt;optional&gt; the IncomingTransfer tied to the Reservation timeout number The number of seconds until the Task times out workerSid string The sid of the Worker workspaceSid string The sid of the Workspace owning this Reservation version string The version of this Reservation Fires: Reservation#event:accepted Reservation#event:canceled Reservation#event:completed Reservation#event:rejected Reservation#event:rescinded Reservation#event:timeout Reservation#event:wrapup Extends EventEmitter Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; canceledReasonCode :number|undefined Type: number | undefined &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; status :\"pending\"|\"accepted\"|\"rejected\"|\"timeout\"|\"canceled\"|\"rescinded\"|\"wrapping\"|\"completed\" Type: \"pending\" | \"accepted\" | \"rejected\" | \"timeout\" | \"canceled\" | \"rescinded\" | \"wrapping\" | \"completed\" &lt;readonly&gt; task :Task|Object Type: Task | Object &lt;readonly&gt; timeout :number Type: number &lt;readonly&gt; transfer :IncomingTransfer|Object Type: IncomingTransfer | Object &lt;readonly&gt; version :string Type: string &lt;readonly&gt; workerSid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Methods accept() Accept the Reservation Returns: Rejected if unable to issue Accept instruction on the Reservation Type Promise.&lt;this&gt; call(from, url [, options]) Issue a Call to a Worker Parameters: Name Type Argument Description from string The caller id for the call to a Worker url string A valid TwiML URI that is executed on the answering Worker's leg options CallOptions &lt;optional&gt; Returns: Rejected if unable to issue Call instruction on the Reservation Type Promise.&lt;this&gt; complete() Complete the Reservation Returns: Rejected if unable to issue Complete instruction on the Reservation Type Promise.&lt;this&gt; conference( [options]) Conference the active Call tied to this Reservation to the Worker Parameters: Name Type Argument Description options ConferenceOptions &lt;optional&gt; Returns: Rejected if unable to issue Conference instruction on the link Reservation Type Promise.&lt;this&gt; dequeue( [options]) Dequeue the Reservation to the Worker. This will perform telephony to dequeue a Task that was enqueued using the Enqueue TwiML verb. A contact_uri must exist in the Worker's attributes for this call to go through. Parameters: Name Type Argument Description options DequeueOptions &lt;optional&gt; Returns: Rejected if unable to issue Dequeue instruction on the Reservation Type Promise.&lt;this&gt; fetchLatestVersion() Fetch the last version of this Reservation Returns: Type Promise.&lt;Reservation&gt; redirect(callSid, url [, options]) Redirect the active Call tied to this Reservation Parameters: Name Type Argument Description callSid string The sid of the Call to redirect url string A valid TwiML URI that is executed on the Caller's leg upon redirecting options RedirectOptions &lt;optional&gt; Returns: Rejected if unable to issue Redirect instruction on the Reservation Type Promise.&lt;this&gt; reject( [options]) Reject the Reservation Parameters: Name Type Argument Description options RejectOptions &lt;optional&gt; Returns: Rejected if unable to issue Reject instruction on the Reservation Type Promise.&lt;this&gt; updateParticipant(options) Update the Worker's leg in the Conference associated to this Reservation Parameters: Name Type Description options ReservationParticipantOptions Returns: Rejected if unable to update the Worker's leg in the Conference tied to the Reservation Type Promise.&lt;this&gt; wrap() Wrap the Reservation Returns: Rejected if unable to issue Wrap instruction on the Reservation Type Promise.&lt;this&gt; Events accepted Fired when a Reservation has been accepted for this Worker Parameters: Name Type Description reservation Reservation The accepted Reservation canceled Fired when a Reservation has been canceled for this Worker Parameters: Name Type Description reservation Reservation The canceled Reservation completed Fired when an accepted Reservation has been completed for this Worker Parameters: Name Type Description reservation Reservation The completed Reservation rejected Fired when a Reservation has been rejected for this Worker Parameters: Name Type Description reservation Reservation The rejected Reservation rescinded Fired when a Reservation has been rescinded for the Worker Parameters: Name Type Description reservation Reservation The rescinded Reservation timeout Fired when a Reservation has been timed out for this Worker Parameters: Name Type Description reservation Reservation The timed out Reservation wrapup Fired when a Reservation has been wrapped up for the Worker Parameters: Name Type Description reservation Reservation The wrapped up Reservation × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Supervisor.html":{"id":"Supervisor.html","title":"Class: Supervisor","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Supervisor Supervisor Create a Supervisor client representing a privileged TaskRouter Worker new Supervisor(token [, options]) Parameters: Name Type Argument Description token string The string token options WorkerOptions &lt;optional&gt; Fires: Supervisor#event:monitor Extends Worker Members &lt;readonly&gt; accountSid :string Type: string Inherited From: Worker#accountSid activities Inherited From: Worker#activities &lt;readonly&gt; activity Inherited From: Worker#activity &lt;readonly&gt; attributes :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; Inherited From: Worker#attributes channels Inherited From: Worker#channels &lt;readonly&gt; dateActivityChanged :Date Type: Date Inherited From: Worker#dateActivityChanged &lt;readonly&gt; dateCreated :Date Type: Date Inherited From: Worker#dateCreated &lt;readonly&gt; dateStatusChanged :Date Type: Date Inherited From: Worker#dateStatusChanged &lt;readonly&gt; dateUpdated :Date Type: Date Inherited From: Worker#dateUpdated &lt;readonly&gt; friendlyName :string Type: string Inherited From: Worker#friendlyName &lt;readonly&gt; name :string Type: string Inherited From: Worker#name reservations Inherited From: Worker#reservations &lt;readonly&gt; sid :string Type: string Inherited From: Worker#sid version :string Type: string Inherited From: Worker#version &lt;readonly&gt; workerActivitySid :string Type: string Inherited From: Worker#workerActivitySid &lt;readonly&gt; workerSid :string Type: string Inherited From: Worker#workerSid &lt;readonly&gt; workspaceSid :string Type: string Inherited From: Worker#workspaceSid Methods _bumpVersion() bumps the worker version Inherited From: Worker#_bumpVersion createTask(to, from, workflowSid, taskQueueSid [, options]) Create a Task Parameters: Name Type Argument Description to string The contact uri of the customer. Stored in the Task's attributes as \"outbound_to\" from string The contact uri of the Worker. Stored in the Task's attributes as \"from\" workflowSid string The Sid of the Workflow this Task should belong to taskQueueSid string The Sid of the TaskQueue this Task should belong to, used for reporting purposes only options WorkerTaskOptions &lt;optional&gt; Inherited From: Worker#createTask Returns: Rejected if unable to create a Task on behalf of the Worker. Returns the TaskSid of the created Task. Type Promise.&lt;string&gt; disconnect() Gracefully disconnect the client. Inherited From: Worker#disconnect Returns: Type void fetchLatestVersion() Fetch the last version of this Worker Inherited From: Worker#fetchLatestVersion Returns: Type Promise.&lt;this&gt; getLogger(prefix) Parameters: Name Type Description prefix string Inherited From: Worker#getLogger Returns: Type Logger getRoutes() Inherited From: Worker#getRoutes Returns: Type Routes monitor(taskSid, reservationSid [, extraParams]) Add this Supervisor to an ongoing Reservation by Sid. Parameters: Name Type Argument Description taskSid string The sid of the Task to add a monitor to. reservationSid string The sid of the Reservation to add a monitor to. extraParams Record.&lt;any, any&gt; &lt;optional&gt; An object containing extra params to append to the payload. Returns: Promise setAttributes(attributes) Update attributes Parameters: Name Type Description attributes Record.&lt;any, any&gt; A JSON describing the Worker's attributes Inherited From: Worker#setAttributes Returns: Rejected if the attributes cannot be set Type Promise.&lt;this&gt; updateToken(newToken) Update token Parameters: Name Type Description newToken string The new token that should be used for authentication Inherited From: Worker#updateToken Returns: Emits error if unable to update token Type void Events activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:activityUpdated attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker Inherited From: Worker#event:attributesUpdated disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected Inherited From: Worker#event:disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred Inherited From: Worker#event:error monitor Add this Supervisor to an ongoing Reservation by Sid. Parameters: Name Type Argument Description taskSid string The sid of the Task to add a monitor to. reservationSid string The sid of the Reservation to add a monitor to. extraParams Object &lt;optional&gt; An object containing extra params to append to the payload. ready Worker is ready to listen for events and take action Inherited From: Worker#event:ready reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation Inherited From: Worker#event:reservationCreated reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation Inherited From: Worker#event:reservationFailed tokenExpired The Worker token has expired Inherited From: Worker#event:tokenExpired tokenUpdated The Worker token has successfully updated Inherited From: Worker#event:tokenUpdated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Task.html":{"id":"Task.html","title":"Class: Task","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Task Task A Task represents an item of work new Task(worker, request, reservationSid, descriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request reservationSid string The SID of the Reservation associated with this Task descriptor TaskDescriptor The data descriptor which describes this Task Properties: Name Type Description addOns Record.&lt;any, any&gt; The addons attached to the Task age number The age of the Task in seconds attributes Record.&lt;any, any&gt; The attributes of the Task dateCreated Date The date the Task was created dateUpdated Date The date the Task was last updated priority number The priority of the Task queueName string The friendly name of the TaskQueue the Task is currently in queueSid string The sid of the TaskQueue the Task is currently in reason string The reason the Task was completed or canceled, if applicable routingTarget string The target Sid of the Worker, TaskQueue, or Workflow this Task will be routed to. sid string The sid of the Task status string The status of the Task. Options: ['pending', 'reserved', 'assigned', 'canceled', 'completed', 'wrapping'] taskChannelSid string The sid of the Task Channel associated to the Task in MultiTask mode taskChannelUniqueName string The unique name of the Task Channel associated to the Task in MultiTask mode timeout number The number of seconds the Task is allowed to live transfers Transfers The IncomingTransfer and OutgoingTransfer related to this Task, if applicable workflowName string The name of the Workflow responsible for routing the Task workflowSid string The sid of the Workflow responsible for routing the Task version string The version of this Task reservationSid string The sid of Reservation virtualStartTime Date Optionally set starting time of the Task, in cases where the interaction between the customer and agents spans across multiple tasks. If not provided, defaults to dateCreated. Fires: Task#event:canceled Task#event:completed Task#event:transferAttemptFailed Task#event:transferCanceled Task#event:transferCompleted Task#event:transferFailed Task#event:transferInitiated Task#event:updated Task#event:wrapup Extends EventEmitter Members &lt;readonly&gt; addOns :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; &lt;readonly&gt; age :number Type: number &lt;readonly&gt; attributes :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; priority :number Type: number &lt;readonly&gt; queueName :string Type: string &lt;readonly&gt; queueSid :string Type: string &lt;readonly&gt; reason :string Type: string &lt;readonly&gt; reservationSid :string Type: string &lt;readonly&gt; routingTarget :string Type: string &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; status :'pending'|'reserved'|'assigned'|'canceled'|'completed'|'wrapping' Type: 'pending' | 'reserved' | 'assigned' | 'canceled' | 'completed' | 'wrapping' &lt;readonly&gt; taskChannelSid :string Type: string &lt;readonly&gt; taskChannelUniqueName :string Type: string &lt;readonly&gt; timeout :number Type: number &lt;readonly&gt; transfers :Transfers Type: Transfers &lt;readonly&gt; version :string Type: string &lt;readonly&gt; virtualStartTime :Date Type: Date &lt;readonly&gt; workflowName :string Type: string &lt;readonly&gt; workflowSid :string Type: string Methods complete(reason) Update the Task status to 'completed' Parameters: Name Type Description reason string The reason for completing the Task Returns: Rejected if the Task state could not be updated to 'completed' Type Promise.&lt;this&gt; fetchLatestVersion() Fetch the last version of this Task Returns: Type Promise.&lt;Task&gt; hold(targetWorkerSid, onHold, options) Hold the worker's call leg in the Conference associated to this Task and specified TargetWorkerSid Parameters: Name Type Description targetWorkerSid String The target worker's sid which should be put onhold or unhold onHold boolean Whether to hold or unhold the specified worker's call leg in the Conference referenced by the Task options TaskHoldOptions Returns: Type Promise.&lt;this&gt; kick(workerSid) Kick another active Worker participant from the ongoing conference Parameters: Name Type Description workerSid string The Sid of the Worker who is currently in the conference that should be kicked Returns: Rejected if unable to kick the call leg of the targeted Worker in the Conference tied to the Task Type Promise.&lt;this&gt; setAttributes(attributes) Update the Task attributes to the given attributes. Parameters: Name Type Description attributes Record.&lt;any, any&gt; A JSON to update the attributes. Returns: Rejected if the attributes cannot be set Type Promise.&lt;this&gt; setVirtualStartTime(date) Set virtual start time of the Task. Parameters: Name Type Description date Date Virtual start time as a Date. Returns: Rejected if fails to set the time. Type Promise.&lt;this&gt; &lt;async&gt; transfer(to [, options]) Transfer the Task to another entity. Parameters: Name Type Argument Description to string The Worker or TaskQueue entity sid to transfer the task to. options TransferOptions &lt;optional&gt; Returns: Type Promise.&lt;this&gt; updateParticipant(options) Update the Customer leg in the Conference associated to this Task Parameters: Name Type Description options TaskParticipantOptions Returns: Rejected if unable to update the Customers' leg in the Conference tied to the Task Type Promise.&lt;this&gt; wrapUp(options) Update the Task status to 'wrapping' in a multi-task enabled Workspace Parameters: Name Type Description options WrappingOptions Returns: Rejected if the Task state could not be updated to 'wrapping' Type Promise.&lt;this&gt; Events canceled The Task was canceled Parameters: Name Type Description task Task The Task who was canceled completed The Task was completed Parameters: Name Type Description task Task The Task who was completed transferAttemptFailed An OutgoingTransfer attempt has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCanceled An OutgoingTransfer has been canceled for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferCompleted An OutgoingTransfer has been competed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferFailed An OutgoingTransfer has been failed for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer transferInitiated An OutgoingTransfer has been initiated for Task Parameters: Name Type Description outgoingTransfer OutgoingTransfer The currently in process OutgoingTransfer updated The attributes of this Task was updated Parameters: Name Type Description task Task The Task whose attributes were updated wrapup The Task was wrapped up Parameters: Name Type Description task Task The Task who was wrapped up × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"TaskQueue.html":{"id":"TaskQueue.html","title":"Class: TaskQueue","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: TaskQueue TaskQueue A TaskQueue represents a set of Tasks awaiting assignment. new TaskQueue(descriptor) Parameters: Name Type Description descriptor TaskQueueDescriptor The TaskQueueDescriptor of this TaskQueue Properties: Name Type Description sid string The Sid of the TaskQueue queueSid string The Sid of the TaskQueue accountSid string The Sid of the owning Account of the TaskQueue} workspaceSid string The Sid of the Workspace the TaskQueue belongs to name string The friendly name of the TaskQueue queueName string The friendly name of the TaskQueue assignmentActivityName string The Activity name for the reservation of the TaskQueue reservationActivityName string The Activity name for the assignment of the TaskQueue assignmentActivitySid string The Sid of the assignment Activity for the TaskQueue reservationActivitySid string The Sid of the reservation Activity for the TaskQueue targetWorkers string The expression used to target workers maxReservedWorkers number The maximum number of reserved workers for the TaskQueue taskOrder string The task order for the TaskQueue FIFO or LIFO dateCreated Date The date when the TaskQueue was created dateUpdated Date The date when the TaskQueue was last updated Members &lt;readonly&gt; accountSid :string Type: string &lt;readonly&gt; assignmentActivityName :string Type: string &lt;readonly&gt; assignmentActivitySid :string Type: string &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; maxReservedWorkers :number Type: number &lt;readonly&gt; name :string Type: string &lt;readonly&gt; queueName :string Type: string &lt;readonly&gt; queueSid :string Type: string &lt;readonly&gt; reservationActivityName :string Type: string &lt;readonly&gt; reservationActivitySid :string Type: string &lt;readonly&gt; sid :string Type: string &lt;readonly&gt; targetWorkers :string Type: string &lt;readonly&gt; taskOrder :string Type: string &lt;readonly&gt; workspaceSid :string Type: string × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Transfers.html":{"id":"Transfers.html","title":"Class: Transfers","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Transfers Transfers Transfers contains both the IncomingTransfer and OutgoingTransfer for the Worker new Transfers(worker, request, taskDescriptor) Parameters: Name Type Description worker Worker The Worker request Request The Request taskDescriptor TaskDescriptor The task descriptor which describes the related Task Properties: Name Type Description incoming IncomingTransfer The IncomingTransfer for the Worker if the related Reservation was initiated via transfer by another agent outgoing OutgoingTransfer The current active (initiated but not yet finished) OutgoingTransfer initiated by the Worker to another agent or queue Extends EventEmitter Members incoming :IncomingTransfer Type: IncomingTransfer outgoing :OutgoingTransfer Type: OutgoingTransfer Methods _emitEvent(eventType, rawEventData) Emit the transfer event and handle any appropriate clean-up or data modification Parameters: Name Type Description eventType Object the name of the transfer event rawEventData Object the raw payload contents of the event _update(latestTransfersData) Update Transfers using the latest transfers data Parameters: Name Type Description latestTransfersData Object The latest transfers data × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Worker.html":{"id":"Worker.html","title":"Class: Worker","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Worker Worker Create a Worker client representing a TaskRouter Worker new Worker(token [, options] [, deps]) Parameters: Name Type Argument Description token string The string token options WorkerOptions &lt;optional&gt; deps WorkerDeps &lt;optional&gt; Properties: Name Type Description accountSid string The sid of the Twilio account activities Map.&lt;string, Activity&gt; The list of possible states a Worker can be activity Activity The current Activity of the Worker activitySid string The sid of the Activity the Worker is currently in activityName string The current Activity name the Worker is currently in attributes Record.&lt;any, any&gt; A JSON representation of the Worker's attributes available boolean Whether or not the Worker is available to take on Tasks channels Map.&lt;string, Channel&gt; The list of available Channels connectActivitySid string The Activity to set the Worker as on connect dateCreated Date The date this Worker was created dateStatusChanged Date The date this Worker's activity was last changed dateUpdated Date The date this Worker was last updated name string The friendly name of the Worker reservations Map.&lt;string, Reservation&gt; A list of pending Reservations for the Worker sid string The sid of the Worker workspaceSid string The sid of the Workspace owning this Worker workerSid string The sid of the Worker, duplicates sid field for backwards compatibility workerActivitySid string The sid of the Activity the Worker is currently in, duplicates activitySid field for backwards compatibility dateActivityChanged Date The date when the Worker's state was last changed, duplicates dateStatusChanged field for backwards compatibility friendlyName string The friendly name of the Worker, duplicates name field for backwards compatibility version string The version of this Worker Fires: Worker#event:activityUpdated Worker#event:attributesUpdated Worker#event:disconnected Worker#event:error Worker#event:ready Worker#event:reservationCreated Worker#event:reservationFailed Worker#event:tokenExpired Worker#event:tokenUpdated Extends EventEmitter Members &lt;readonly&gt; accountSid :string Type: string activities &lt;readonly&gt; activity &lt;readonly&gt; attributes :Record.&lt;any, any&gt; Type: Record.&lt;any, any&gt; channels &lt;readonly&gt; dateActivityChanged :Date Type: Date &lt;readonly&gt; dateCreated :Date Type: Date &lt;readonly&gt; dateStatusChanged :Date Type: Date &lt;readonly&gt; dateUpdated :Date Type: Date &lt;readonly&gt; friendlyName :string Type: string &lt;readonly&gt; name :string Type: string reservations &lt;readonly&gt; sid :string Type: string version :string Type: string &lt;readonly&gt; workerActivitySid :string Type: string &lt;readonly&gt; workerSid :string Type: string &lt;readonly&gt; workspaceSid :string Type: string Methods _bumpVersion() bumps the worker version createTask(to, from, workflowSid, taskQueueSid [, options]) Create a Task Parameters: Name Type Argument Description to string The contact uri of the customer. Stored in the Task's attributes as \"outbound_to\" from string The contact uri of the Worker. Stored in the Task's attributes as \"from\" workflowSid string The Sid of the Workflow this Task should belong to taskQueueSid string The Sid of the TaskQueue this Task should belong to, used for reporting purposes only options WorkerTaskOptions &lt;optional&gt; Returns: Rejected if unable to create a Task on behalf of the Worker. Returns the TaskSid of the created Task. Type Promise.&lt;string&gt; disconnect() Gracefully disconnect the client. Returns: Type void fetchLatestVersion() Fetch the last version of this Worker Returns: Type Promise.&lt;this&gt; getLogger(prefix) Parameters: Name Type Description prefix string Returns: Type Logger getRoutes() Returns: Type Routes setAttributes(attributes) Update attributes Parameters: Name Type Description attributes Record.&lt;any, any&gt; A JSON describing the Worker's attributes Returns: Rejected if the attributes cannot be set Type Promise.&lt;this&gt; updateToken(newToken) Update token Parameters: Name Type Description newToken string The new token that should be used for authentication Returns: Emits error if unable to update token Type void Events activityUpdated Worker activity has updated Parameters: Name Type Description worker Worker The updated Worker attributesUpdated Worker attributes have updated Parameters: Name Type Description worker Worker The updated Worker disconnected The signaling layer has lost the websocket connection Parameters: Name Type Description reason Object The reason the Worker websocket disconnected error An error has occurred Parameters: Name Type Description error Error The Error that occurred ready Worker is ready to listen for events and take action reservationCreated A Reservation has been created for the Worker Parameters: Name Type Description reservation Reservation The created Reservation reservationFailed Worker was unable to receive a Reservation for the Task it created Parameters: Name Type Description task Object The raw Task-like payload that failed to generate a Reservation tokenExpired The Worker token has expired tokenUpdated The Worker token has successfully updated × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "},"Workspace.html":{"id":"Workspace.html","title":"Class: Workspace","body":" Documentation Classes ActivityChannelIncomingTransferOutgoingTransferReservationSupervisorTaskTaskQueueTransfersWorkerWorkspace Events Channel#event:availabilityUpdatedChannel#event:capacityUpdatedOutgoingTransfer#event:attemptFailedOutgoingTransfer#event:canceledOutgoingTransfer#event:completedOutgoingTransfer#event:failedReservation#event:acceptedReservation#event:canceledReservation#event:completedReservation#event:rejectedReservation#event:rescindedReservation#event:timeoutReservation#event:wrapupSupervisor#event:activityUpdatedSupervisor#event:attributesUpdatedSupervisor#event:disconnectedSupervisor#event:errorSupervisor#event:monitorSupervisor#event:readySupervisor#event:reservationCreatedSupervisor#event:reservationFailedSupervisor#event:tokenExpiredSupervisor#event:tokenUpdatedTask#event:canceledTask#event:completedTask#event:transferAttemptFailedTask#event:transferCanceledTask#event:transferCompletedTask#event:transferFailedTask#event:transferInitiatedTask#event:updatedTask#event:wrapupWorker#event:activityUpdatedWorker#event:attributesUpdatedWorker#event:disconnectedWorker#event:errorWorker#event:readyWorker#event:reservationCreatedWorker#event:reservationFailedWorker#event:tokenExpiredWorker#event:tokenUpdated Global Global Class: Workspace Workspace Create a Workspace client representing a TaskRouter Workspace new Workspace(jwt [, options] [, workspaceSid]) Parameters: Name Type Argument Description jwt string The string token options WorkspaceOptions &lt;optional&gt; workspaceSid string &lt;optional&gt; Sid of this Workspace, has to be provided if JWE token is passed Throws: Exception if workspaceSid is not passed with JWE token Members &lt;readonly&gt; workspaceSid :string Type: string workspaceSid :string Type: string Methods fetchTaskQueue(queueSid) Fetch task queue of this Workspace by given sid Parameters: Name Type Description queueSid string the sid of the task queue to fetch Returns: fetchTaskQueues( [params]) Fetch task queues of this Workspace Parameters: Name Type Argument Description params FetchTaskQueuesParams &lt;optional&gt; Returns: fetchWorker(workerSid) Fetch worker of this Workspace by given sid Parameters: Name Type Description workerSid string the sid of the worker to fetch Returns: fetchWorkers( [params]) Fetch workers of this Workspace Parameters: Name Type Argument Description params FetchWorkersParams &lt;optional&gt; Returns: updateToken(newToken) Update token Parameters: Name Type Description newToken string The new token that should be used for authentication Returns: throws error if unable to update token Type void × Search results Close Documentation generated by JSDoc 3.6.11 on 2024-04-17T12:33:19+00:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">