Grupos
Gerencie grupos de WhatsApp com a Wazend: criar, listar, entrar, adicionar ou remover participantes, administradores, segurança, foto e mais.
Gerencie os grupos de WhatsApp com a API.
{session}— nome da sua sessão (aparece no Dashboard, por exemploS0001).{groupId}— ID do grupo no formato123123123123@g.us.
Informação
Se você vir @lid na lista de participantes, consulte a página de Contatos.
Criar um novo grupo
POST /api/{session}/groups{
"name": "Mi grupo",
"participants": [
{ "id": "5215551234567@c.us" },
{ "id": "5219999999999@c.us" }
]
}Obter todos os grupos
GET /api/{session}/groupsA resposta depende do motor (engine) que você usa.
Parâmetros de consulta:
GET /api/{session}/groups?limit=20&offset=0&sortBy=subject&sortOrder=desc-
limit=10— limita o número de grupos a retornar. -
offset=0— ignora N grupos desde o início. -
sortBy— ordena por campo:sortBy=id— por ID do grupo.sortBy=subject— por assunto do grupo.
-
sortOrder=desc|asc— ordem:desc— decrescente (novos primeiro, A–Z).asc— crescente (antigos primeiro, Z–A).
-
exclude=participants— exclui os dados de participantes da resposta.
Dica
Se você vir timeout ou a requisição demorar muito, use limit para obter os objetos em partes menores.
Aviso
Se você vir o erro rate-overlimit com o motor NOWEB, tente habilitar o NOWEB Store.
Obter o número de grupos
GET /api/{session}/groups/count{ "count": 10 }Entrar num grupo
Se você tiver o link de convite, entre mediante o código ou a URL completa:
POST /api/{session}/groups/join{
"code": "https://chat.whatsapp.com/INVITECODE"
}{ "id": "5215551234567@g.us" }Obter info de convite do grupo
GET /api/{session}/groups/join-info?code=invitecodeOu usando o link completo (lembre-se de codificar a URL):
GET /api/{session}/groups/join-info?code=https%3A%2F%2Fchat.whatsapp.com%2FinvitecodeAtualizar grupos
POST /api/{session}/groups/refreshAviso
Não chame com frequência, pode provocar um erro rate-overlimit. Normalmente a API de grupos já tem a informação atualizada.
Obter o grupo
GET /api/{session}/groups/{groupId}Excluir o grupo
DELETE /api/{session}/groups/{groupId}Sair do grupo
POST /api/{session}/groups/{groupId}/leaveFoto do grupo
Lembre-se de codificar o símbolo @ do ID como %40 (ex. 5215551234567%40g.us).
Obter foto
GET /api/{session}/groups/{ID}/picture?refresh=false{ "url": "https://ejemplo.com/foto.jpg" }url pode ser null se o grupo não tiver foto. Use refresh=true para forçar a atualização (por padrão é cacheada por 24 horas; não atualize com frequência para evitar rate-overlimit).
Alterar foto
PUT /api/{session}/groups/{ID}/picture{
"file": {
"url": "https://ejemplo.com/foto.jpg"
}
}Ou com dados em base64:
{
"file": {
"data": "BASE64_DE_LA_IMAGEN"
}
}Excluir foto
DELETE /api/{session}/groups/{ID}/pictureAlterar o assunto do grupo
PUT /api/{session}/groups/{groupId}/subject{ "subject": "Nuevo asunto" }Retorna true se a atualização for bem-sucedida. Pode retornar false se você não tiver as permissões necessárias.
Alterar a descrição do grupo
PUT /api/{session}/groups/{groupId}/description{ "description": "Nova descrição" }Retorna true se a atualização for bem-sucedida. Pode retornar false se você não tiver as permissões necessárias.
Segurança · editar info somente administradores
Permite que somente os administradores editem as informações do grupo (título, descrição, foto).
GET /api/{session}/groups/{groupId}/settings/security/info-admin-onlyPUT /api/{session}/groups/{groupId}/settings/security/info-admin-only{ "adminsOnly": true }Retorna true se a atualização for bem-sucedida. Pode retornar false se você não tiver as permissões necessárias.
Segurança · mensagens somente administradores
Permite que somente os administradores enviem mensagens.
GET /api/{session}/groups/{groupId}/settings/security/messages-admin-onlyPUT /api/{session}/groups/{groupId}/settings/security/messages-admin-only{ "adminsOnly": true }Retorna true se a atualização for bem-sucedida. Pode retornar false se você não tiver as permissões necessárias.
Segurança · quem pode adicionar membros
Controla se todos os membros ou somente os administradores podem adicionar novos membros.
GET /api/{session}/groups/{groupId}/settings/security/member-add-modePUT /api/{session}/groups/{groupId}/settings/security/member-add-mode{
"membersCanAddNewMember": true
}Retorna true se a atualização for bem-sucedida. Pode retornar false se você não tiver as permissões necessárias.
Participantes
Obter participantes
GET /api/{session}/groups/{groupId}/participants[
{ "id": "5215551234567@c.us", "role": "participant" },
{ "id": "5219999999999@c.us", "role": "admin" }
]Também disponível com uma resposta quase idêntica entre motores:
GET /api/{session}/groups/{groupId}/participants/v2Funções possíveis: left, participant, admin, superadmin.
Adicionar participantes
POST /api/{session}/groups/{groupId}/participants/add{
"participants": [
{ "id": "5215551234567@c.us" }
]
}Remover participantes
POST /api/{session}/groups/{groupId}/participants/remove{
"participants": [
{ "id": "5215551234567@c.us" }
]
}Administradores
Promover a administrador
POST /api/{session}/groups/{groupId}/admin/promote{
"participants": [
{ "id": "5215551234567@c.us" }
]
}Rebaixar a usuário comum
POST /api/{session}/groups/{groupId}/admin/demote{
"participants": [
{ "id": "5215551234567@c.us" }
]
}Código de convite
Obter código
Com o código você pode formar o link https://chat.whatsapp.com/{inviteCode} para compartilhá-lo com seus contatos.
GET /api/{session}/groups/{groupId}/invite-codeRevogar código
Invalida o código de convite atual e gera um novo.
POST /api/{session}/groups/{groupId}/invite-code/revokeEventos
Receba eventos de grupos mediante Eventos: group.v2.join, group.v2.leave, group.v2.participants e group.v2.update. Consulte o detalhe do payload na página de Eventos.