Pular para o conteúdo principal
Use client.groups para operações de grupos WhatsApp em uma instância. Campos comuns em todas as chamadas:
CampoTipoObrigatórioDescrição
instance_idstringSimID da instância.
instance_tokenstringSimToken da instância.
Operações específicas de grupo também exigem group_id no payload.

​
client.groups.list(...)

Lista grupos com paginação. 
groups = client.groups.list(
    instance_id="VZ...",
    instance_token="instance-token",
    page=1,
    page_size=20,
)
print(groups)
Retorno: envelope { code, success, data.groups[] } com paginacao quando aplicavel.

​
client.groups.get(...)

Obtém metadados do grupo. 
group = client.groups.get(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
)
print(group)
Retorno: envelope { code, success, data } com metadados do grupo (jid, name, topic, participantes, etc.). Obtém ou redefine o link de convite. 
invite = client.groups.invite_link(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    reset=False,
)
print(invite)
Retorno: envelope { code, success, data.invite_link }. Com reset: 
new_invite = client.groups.invite_link(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    reset=True,
)

​
client.groups.set_photo(...)

Altera a foto do grupo. Aceita URL pública ou data URL em base64. 
client.groups.set_photo(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    image="https://cdn.example.com/groups/foto.jpg",
)
Retorno: envelope { code, success, data.details } confirmando a alteracao.

​
client.groups.set_name(...)

Altera o nome do grupo. 
client.groups.set_name(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    name="Suporte VIP",
)
Retorno: envelope { code, success, data.details } confirmando a alteracao.

​
client.groups.set_description(...)

Altera a descrição do grupo. 
client.groups.set_description(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    description="Canal oficial de suporte",
)
Retorno: envelope { code, success, data.details } confirmando a alteracao.

​
client.groups.set_settings(...)

Altera configurações do grupo. 
client.groups.set_settings(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    admin_only_message=True,
    admin_only_settings=False,
    delay_message=0,
)
Retorno: envelope { code, success, data.details } confirmando a alteracao.

​
client.groups.create(...)

Cria um grupo com participantes. 
client.groups.create(
    instance_id="VZ...",
    instance_token="instance-token",
    group_name="Suporte VIP",
    group_description="Canal de suporte",
    group_image="https://cdn.example.com/groups/foto.jpg",
    participants=["5511999999999", "5511888888888"],
)
Retorno: envelope { code, success, data } com dados do grupo criado.

​
client.groups.add_admin(...)

Promove participantes a admin. 
client.groups.add_admin(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    participants=["5511999999999"],
)
Retorno: envelope { code, success, data.details } confirmando a alteracao.

​
client.groups.remove_admin(...)

Remove admins do grupo. 
client.groups.remove_admin(
    instance_id="VZ...",
    instance_token="instance-token",
    group_id="120363012345678901@g.us",
    participants=["5511999999999"],
)
Retorno: envelope { code, success, data.details } confirmando a alteracao.