pykazoo.hotdesks

class pykazoo.hotdesks.Hotdesks(rest_request)

2600hz Kazoo Hotdesks API.

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

Create a User’s Hotdesk

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

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

dict
delete_hotdesk(account_id, user_id)

Deletes a User’s Hotdesk

Parameters:
  • account_id (str) – ID of Account to delete Hotdesk from.
  • user_id (str) – ID of User to delete Hotdesk for.
Returns:

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

dict
get_hotdesk(account_id, user_id, filters=None)

Get a User’s Hotdesk for an Account.

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

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

dict
get_hotdesks(account_id, filters=None)

Get all Hotdesks for an Account.

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

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

dict
update_hotdesk(account_id, user_id, data)

Updates a User’s Hotdesk

Parameters:
  • account_id (str) – ID of Account to update Hotdesk for.
  • user_id (str) – ID of Update to create Hotdesk for.
  • data (dict) – Kazoo Account data (see official API Docs).
Returns:

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

dict