Groups

Group management operations for Akuvox devices.

Note

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

async pylocal_akuvox.groups.list_groups(http, *, page=None)[source]

List groups from the device, optionally paginated.

Return type:

list[Group]

Parameters:
  • http (AkuvoxHttpClient)

  • page (int | None)

async pylocal_akuvox.groups.add_group(http, *, name)[source]

Add a group to the device.

Return type:

None

Parameters:
  • http (AkuvoxHttpClient)

  • name (str)

async pylocal_akuvox.groups.modify_group(http, *, id, name)[source]

Modify an existing group on the device.

Return type:

None

Parameters:
  • http (AkuvoxHttpClient)

  • id (str)

  • name (str)

async pylocal_akuvox.groups.delete_group(http, *, id)[source]

Delete a group from the device.

Return type:

None

Parameters:
  • http (AkuvoxHttpClient)

  • id (str)