pykazoo.queues

class pykazoo.queues.Queues(rest_request)

2600hz Kazoo Queues API.

Parameters:rest_request (pykazoo.restrequest.RestRequest) – The request client to use. (optional, default: pykazoo.RestRequest())
create_queue(account_id, data)

Create a Queue

Parameters:
  • account_id (str) – ID of Account to create device for.
  • data (dict) – Kazoo Device data (see official API Docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
delete_queue(account_id, queue_id)

Deletes a Queue

Parameters:
  • account_id (str) – ID of Account to delete Queue from.
  • queue_id (str) – ID of Queue to delete.
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_queue(account_id, queue_id, filters=None)

Get a specific Queue for an Account.

Parameters:
  • account_id (str) – ID of Account to get Queues for.
  • queue_id (str) – ID of the Queue to get.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_queues(account_id, filters=None)

Get all Queues for an Account.

Parameters:
  • account_id (str) – ID of Account to get Queues for.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_queues_stats(account_id, filters=None)

Gets Devices Status

Parameters:
  • account_id (str) – ID of Account to get Queues stats for.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
update_queue(account_id, queue_id, data)

Updates a Queue

Parameters:
  • account_id (str) – ID of Account to update Queue for.
  • queue_id (str) – ID of Queue to update.
  • data (dict) – Kazoo Account data (see official API Docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict