twilio-professional-services / flex-available-queues

Transfer tasks to queues that only have available workers.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Available Task Queues Plugin

What Does This Plugin Do?

This plugin was built to help prevent transferring customers to a queue that does not have available agents.

When an agent clicks on the transfer button, this triggers an event that looks at all the queues, determines which queues have available agents, and only returns a list of queues with available agents. The agent transferring the call can now decide to either warm or cold tranfer the call to one of these queeus.

Disclaimer

This software is to be considered "sample code", a Type B Deliverable, and is delivered "as-is" to the user. Twilio bears no responsibility to support the use or implementation of this software.

Plugin Code Developed and Tested On the Following Versions

Code may not run as expected on higher versions.

  • Twilio Flex UI: 1.25.2
  • Twilio CLI: 2.19.0
  • Twilio CLI Flex Plugin: 4.5.0-beta.0
  • Node: 12.21.0
  • nvm: 7.6.3

Twilio Flex Plugins allow you to customize the appearance and behavior of Twilio Flex. If you want to learn more about the capabilities and how to use the API, check out our Flex documentation.


Setup

See versions in the disclaimer section above to ensure you have the necessary code libraries and tools installed on your local environment

1. Clone this code repo

Clone this code repository to your local environment.

2. npm install dependencies

Once downloaded to your local environment CD into the root of the code and run npm install to install dependencies.

3. Make sure you have installed the Twilio CLI and Flex CLI Plugin extension

How to Run This Code Locally

Using the Twilio CLI make sure you have CD'd into the root of this code directory. Start the code by running the following:

twilio flex:plugins:start

This should open a new browser tab and ask you to log into your Twilio Flex account.

To stop running this plugin press control c on your keyboard to stop the local web server.

How to Deploy This Plugin to Twilio

This plugin can be deployed using the Twilio CLI. This process can be a two step process that includes 1. deploying the code and 2. releasing the code. This can be accomplished entirely through the CLI or through a combination of the CLI and the Flex admin panel. For full instructions on deploying this plugin, please see our documentation here.


Development

Run twilio flex:plugins --help to see all the commands we currently support. For further details on Flex Plugins refer to our documentation on the Twilio Docs page.

About

Transfer tasks to queues that only have available workers.


Languages

Language:JavaScript 100.0%