Grupos

Convidar pessoas para um grupo

POSThttps://api.batzap.com/v1/groups/{jid}/invite

Coloca pessoas num grupo do melhor jeito possível: primeiro adiciona direto, e para quem tem a privacidade bloqueando isso, manda o link de convite por mensagem direta.

No máximo 20 números por chamada; repetidos são removidos. Quem já é membro ou não tem WhatsApp aparece no resultado, mas não recebe mensagem.

As mensagens de convite aparecem na caixa de entrada como qualquer outra. A resposta vem com success: false quando pelo menos um número falhou.

Escopo: groups:write
Limite de uso: Envio · 10/min, 300/dia

Parâmetros de caminho

jidstringobrigatório

JID do grupo (...@g.us), codificado para URL.

Parâmetros do corpo

phone_numbersstring[]obrigatório

De 1 a 20 números no formato E.164.

messagestringopcional

Texto enviado antes do link na mensagem de convite.

integration_iduuidopcional

Número de WhatsApp a partir do qual agir (veja Listar integrações). Preenchido automaticamente quando a chave está restrita a um único número.

Erros

400

JID de grupo inválido, lista vazia, mais de 20 números ou número fora do E.164.

Além dos erros que qualquer rota pode devolver: veja Erros.

AnteriorCriar grupo Próximo Gerenciar participantes

curl -X POST "https://api.batzap.com/v1/groups/120363041234567890%40g.us/invite" \ -H "Authorization: bzp_live_SUA_CHAVE_DE_API" \ -H "Content-Type: application/json" \ -d '{ "phone_numbers": [ "+5511987654321", "+5511912345678" ], "message": "Entra no grupo do projeto:" }'

{ "success": true, "message": "1 added, 1 invited by link, 0 failed", "data": { "jid": "120363041234567890@g.us", "invite_link": "https://chat.whatsapp.com/abc123", "summary": { "added": 1, "invited": 1, "failed": 0 }, "results": [ { "phone_number": "+5511987654321", "result": "added", "detail": "added to the group" }, { "phone_number": "+5511912345678", "result": "invited", "detail": "could not be added directly — invite link sent by direct message" } ] } }