Skip to content

KAZOO Support Channels

This documentation is curated by 2600Hz as part of the KAZOO open source project. Join our community forums here for peer support. Only features in the docs.2600hz.com/supported space are included as part of our 2600Hz Support Services plan.

Qubicle User Guide#

This guide will provide an overview of interaction with the Qubicle system from the viewpoint of a recipient (agent).

Prerequisites#

  • A valid user that has a device configured, and is enabled as a Qubicle recipient

Recipient States#

A recipient can be in one of three states at any given time. Not logged in, Logged in but 'away', and Logged in and 'ready'. In order for a recipient to be considered for routing a call they must be both logged in, and in the ready state.

Managing state#

Login state is managed for a recipient by using the Recipient Crossbar API. More specifically the "Set recipient status" method. Setting the recipients status value to 'login' will initiate the login process for that recipient, setting it to 'logout' will log out and terminate the process for the recipient.

Ready and away state are also managed using the same API call, with either the status being 'ready' or 'away'.

A quick example#

So in order for you as a recipient to log in and take a call, you would need to perform the following two API calls to set yourself as logged in and ready:

curl -v -X POST -H "X-Auth-Token: {AUTH_TOKEN}" -H "Content-Type: application/json" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/qubicle_recipients/{USER_ID}/status -d '{"data":{"status":"login"}}'
curl -v -X POST -H "X-Auth-Token: {AUTH_TOKEN}" -H "Content-Type: application/json" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/qubicle_recipients/{USER_ID}/status -d '{"data":{"status":"ready"}}'