pykazoo.voicemailboxes

class pykazoo.voicemailboxes.VoicemailBoxes(rest_request)

2600hz Kazoo VoicemailBoxes API.

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

Create a VoicemailBoxes

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

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

dict
delete_voicemail_box(account_id, voicemail_box_id)

Deletes a VoicemailBoxes

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

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

dict
get_voicemail_box(account_id, voicemail_box_id, filters=None)

Get a specific VoicemailBoxes for an Account.

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

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

dict
get_voicemail_boxes(account_id, filters=None)

Get all VoicemailBoxes for an Account.

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

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

dict
update_voicemail_box(account_id, voicemail_box_id, data)

Updates a VoicemailBox

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

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

dict