pykazoo.timedroutes

class pykazoo.timedroutes.TimedRoutes(rest_request)

2600hz Kazoo Timed Routes API.

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

Create a Timed Route

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

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

dict
delete_timed_route(account_id, timed_route_id)

Deletes a Timed Route

Parameters:
  • account_id (str) – ID of Account to delete Timed Route from.
  • timed_route_id (str) – ID of Timed Route to delete.
Returns:

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

dict
get_timed_route(account_id, timed_route_id, filters=None)

Get a specific Timed Route for an Account.

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

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

dict
get_timed_routes(account_id, filters=None)

Get all Timed Routes for an Account.

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

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

dict
update_timed_route(account_id, timed_route_id, data)

Updates a Timed Route

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

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

dict