Contacts

Contact management operations for Akuvox devices.

Note

This module uses the /api/contact/* HTTP endpoints which manage a separate data store from the Akuvox device web UI. Contacts created via these endpoints will not appear in the web UI, and vice-versa. The web UI uses session-authenticated /web/ endpoints that are not supported by this library.

async pylocal_akuvox.contacts.list_contacts(http, *, page=None)[source]

List contacts from the device, optionally paginated.

Return type:

list[Contact]

Parameters:

  • http (AkuvoxHttpClient)

  • page (int | None)

async pylocal_akuvox.contacts.add_contact(http, *, name, phone=None, group=None)[source]

Add a contact to the device address book.

Return type:

None

Parameters:

  • http (AkuvoxHttpClient)

  • name (str)

  • phone (str | None)

  • group (str | None)

async pylocal_akuvox.contacts.modify_contact(http, *, id, name=None, phone=None, group=None)[source]

Modify an existing contact on the device.

The device requires a full contact record for set operations, so this fetches the current record and merges changes.

Return type:

None

Parameters:

  • http (AkuvoxHttpClient)

  • id (str)

  • name (str | None)

  • phone (str | None)

  • group (str | None)

async pylocal_akuvox.contacts.delete_contact(http, *, id)[source]

Delete one or more contacts from the device.

Return type:

None

Parameters: