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 quickstart guide#

This guide will get you up and running with a single queue and a single recipient as quickly as possible.

Prerequisites#

  • A valid user that has a device configured
  • A valid extension that is set up in callflows to route to an arbitrary voicemail box.

Configure the queue#

We will configure a queue with default values to use. The configuration will be done via Crossbar, so you must obtain a valid API token before continuing. Use the following command to configure the basic queue:

curl -v -X PUT -H "X-Auth-Token: {AUTH_TOKEN}" -H "Content-Type: application/json" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/qubicle_queues -d '{"data":{"name":"{QUEUE_NAME}"}}'

Configure the Callflows document#

We will now alter the callflow that you have already configured (from the prerequisites). We will be changing the flow so that instead of routing to an arbitrary voicemail box the flow will send the call to Qubicle. The can be achieved by PATCH'ing the callflow like so:

curl -H "X-Auth-Token: {AUTH_TOKEN}" http://{SERVER}:8000/v1/accounts/{ACCOUNT_ID}/callflows/{CALLFLOW_ID} -X PATCH -d '{"data":{"flow":{"data":{"queue_id":"{QUEUE_ID}"},"module":"qubicle"}}}'

Configure the user#

Now we need to enable the user as a Qubicle recipient, this can be done with the following PATCH command:

 curl -v -X PATCH -H "X-Auth-Token: {AUTH_TOKEN}" -H "Content-Type: application/json" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/users/{USER_ID} -d '{"data":{"qubicle":{"enabled":"true"}}}'

Add the recipient to the queue#

Now that we have both a queue and a recipient configured, we can add the recipient as a member of the queue for consideration when routing calls from that queue. This can be done with the following API method:

curl -v -X POST -H "X-Auth-Token: {AUTH_TOKEN}" -H "Content-Type: application/json" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/qubicle_queues/{QUEUE_ID}/recipients -d '{"data": {"action": {ACTION}, "members":["{USER_ID_1}", "{USER_ID_2}"]}}'

Notes#

At this point you will have a basic queue that you can call into (via the Callflow routing) and a recipient that will receive those calls. For more information on how to log the recipient in and manage calls please refer to the Callflow User Guide