pykazoo.phonenumbers

class pykazoo.phonenumbers.PhoneNumbers(rest_request)

2600hz Kazoo PhoneNumbers API.

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

Create a Phone Number

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

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

dict
delete_phone_number(account_id, phone_number)

Deletes a Device

Parameters:
  • account_id (str) – ID of Account to delete device from.
  • phone_number (str) – Phone Number to delete.
Returns:

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

dict
get_phone_number(account_id, phone_number, filters=None)

Get a specific Phone Number for an Account.

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

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

dict
get_phone_numbers(account_id, filters=None)

Get all Phone Numbers for an Account.

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

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

dict
update_phone_number(account_id, phone_number, data)

Updates a Phone Number

Parameters:
  • account_id (str) – ID of Account to update device for.
  • phone_number (str) – ID of Phone Number to update.
  • data (dict) – Kazoo Account data (see official API Docs).
Returns:

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

dict