pykazoo.clicktocalls

class pykazoo.clicktocalls.ClickToCalls(rest_request)

2600hz Kazoo Click to Call API.

Parameters:rest_request (pykazoo.restrequest.RestRequest) – The request client to use. (optional, default: pykazoo.RestRequest())
connect_click_to_call(account_id, click_to_call_id, filters=None)

Connects a Click to Call

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

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

dict
create_click_to_call(account_id, data)

Create a Click to Call

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

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

dict
delete_click_to_call(account_id, click_to_call_id)

Deletes a Click to Call

Parameters:
  • account_id (str) – ID of Account to delete Click to Call from.
  • click_to_call_id (str) – ID of Click to Call to delete.
Returns:

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

dict
get_click_to_call(account_id, click_to_call_id, filters=None)

Get a specific Click to Call for an Account.

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

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

dict
get_click_to_call_history(account_id, click_to_call_id, filters=None)

Gets history for a Click to Call

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

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

dict
get_click_to_calls(account_id, filters=None)

Get all Click to Calls for an Account.

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

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

dict
update_click_to_call(account_id, click_to_call_id, data)

Updates a Click to Call

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

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

dict