gc-queue-visual-audio-alerter

Audio and Visual alerter for Genesys Cloud queued interactions

About The Project

This script can be used by Genesys Cloud customers who require external audio/visual alerting devices to be deployed in their premises. An example would be a warehouse setting or on-call environment where the agent/staff is not required at their desk at all times.

When a call enters one of the monitored queues, the device will emit sound and light, alerting the staff member(s) to the waiting interaction. The script can monitor multiple queues concurrently.

The Script is designed to run on a small single-board computer such as the Raspberry Pi Zero W, using it's GPIO pins as outputs to control the light/sound.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

The Genesys Cloud Python Platform API Client SDK is required to run this script. As are standard python libraries: time, requests.

• pip

  pip install PureCloudPlatformClientV2 time requests

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Configure a new Genesys Cloud OAuth client as described here

2. Clone the repo

   git clone https://github.com/GenesysCloudBlueprints/gc-queue-visual-audio-alerter

3. Install python dependencies

   pip install PureCloudPlatformClientV2 time requests

4. Edit gc-queue-visual-audio-alerter/src/gc-queue-visual-audio-alerter.py to add the following:

   • PURECLOUD_CLIENT_ID - The Client ID from the OAuth client you created in Genesys Cloud
   • PURECLOUD_CLIENT_SECRET - The Client Secret from the OAuth client you created in Genesys Cloud
   • buzz_pin - GPIO Pin used for the buzzer (or relay controlling the audio alerting device)
   • led_pin - GPIO Pin used for the led (or relay controlling the visual alerting device)
   • query_interval_time (optional) - Time between API queries in seconds (Default 5)
   • buzz_duration (optional) - Duration of audio alert in seconds (Default 2)
   • queue_names - Populate array with names of queues to be monitored, eg: ["Sales", "Accounts"]
   • PureCloudPlatformClientV2.configuration.host - API URL for relevant region list here

5. Configure gc-queue-visual-audio-alerter.py to run as service at boot (This will depend on the OS/Distro you're running).

(back to top)

Usage

When run as a service, the script will poll the Genesys Cloud API ad the desired intervals to check for interactions waiting in the designated queues. If any of the queues have a waiting interaction, the LED and buzzer will be triggered until the queues are clear.

Contributing

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

My Github page for Genesys Projects: https://github.com/mb-genesys Project Link: https://github.com/GenesysCloudBlueprints/gc-queue-visual-audio-alerter

(back to top)