Guia rápido
Crie uma chave, confira a conexão e envie sua primeira mensagem de WhatsApp pela API em 5 minutos.
Você vai precisar de um número já conectado no painel (em Dispositivos) e da autenticação em duas etapas ativa na sua conta.
Crie uma chave de API
No painel, abra API e integrações → Nova chave. Para este guia:
- Ambiente: Teste (o segredo começa com
zz_test_). - Permissões: modelo Envio de mensagens (
sessions:read,messages:send,events:read). - Validade: 30 dias.
O segredo aparece uma única vez. Copie e guarde num cofre ou variável de ambiente.
Guarde a chave numa variável de ambiente
Todos os exemplos desta documentação leem a chave de ZYNZAP_API_KEY. Nunca coloque a chave no código nem no front-end.
export ZYNZAP_API_KEY="zz_test_..."Confira a chave e descubra o seu número
GetApiKeyIdentity mostra a conta, as permissões e os números que a chave alcança. Em seguida, ListSessions lista os números com o status de conexão: anote o session_id de um número com wa_connected: true.
curl -X POST "https://api.zynzap.com.br/v1/rpc/GetApiKeyIdentity" \
-H "Authorization: Bearer $ZYNZAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request": {}
}'curl -X POST "https://api.zynzap.com.br/v1/rpc/ListSessions" \
-H "Authorization: Bearer $ZYNZAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request": {
"pagination": {
"page": 1,
"page_size": 20
}
}
}'{
"devices": [
{
"session_id": "8c1f7a52-4d1e-4b8a-9a43-2f6f5d0c9e11",
"name": "Loja Centro",
"phone": "5511912345678",
"wa_connected": true,
"wa_status": "SESSION_WA_STATUS_CONNECTED"
}
],
"page": { "page": 1, "page_size": 20, "total_items": "1", "total_pages": 1, "has_next_page": false }
}Peça a cotação do envio
Envios são pagos. Antes de enviar, peça a cotação com exatamente o mesmo request que você vai mandar. Ela devolve o custo máximo e um quoteId válido por 15 minutos.
curl -X POST "https://api.zynzap.com.br/v1/billing/quotes" \
-H "Authorization: Bearer $ZYNZAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"method": "SendMessage",
"request": {
"session_id": "8c1f7a52-4d1e-4b8a-9a43-2f6f5d0c9e11",
"to_jid": "5511987654321",
"text": "Olá! Esta é a minha primeira mensagem pela API do Zynzap."
}
}'{
"quoteId": "0b8f2c1e-3a4d-4e5f-8a9b-1c2d3e4f5a6b",
"kind": "send",
"maxMicrobrl": "50000",
"coveredMicrobrl": "50000",
"dueCents": 0,
"expiresAt": "2026-10-12T14:15:00.000Z"
}maxMicrobrl está em micro-reais (50000 = R$ 0,05). dueCents: 0 significa que o saldo cobre a operação.
Envie a mensagem
Repita o mesmo request e acrescente billing.quoteId. O número de destino vai em to_jid, só com dígitos (DDI + DDD + número).
curl -X POST "https://api.zynzap.com.br/v1/rpc/SendMessage" \
-H "Authorization: Bearer $ZYNZAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request": {
"session_id": "8c1f7a52-4d1e-4b8a-9a43-2f6f5d0c9e11",
"to_jid": "5511987654321",
"text": "Olá! Esta é a minha primeira mensagem pela API do Zynzap."
},
"billing": {
"quoteId": "0b8f2c1e-3a4d-4e5f-8a9b-1c2d3e4f5a6b"
}
}'{
"ok": true,
"detail": "",
"session_id": "8c1f7a52-4d1e-4b8a-9a43-2f6f5d0c9e11",
"to_jid": "[email protected]",
"text": "Olá! Esta é a minha primeira mensagem pela API do Zynzap.",
"sent_at_unix_ms": "1760280000000",
"sent_at_rfc3339": "2026-10-12T14:00:00.000+00:00",
"simulate_typing_used": false,
"typing_simulation_ms": "0"
}Pronto: a mensagem saiu pelo seu número. ok: true significa que o WhatsApp aceitou o envio; a entrega e a leitura chegam depois como evento MessageStatusUpdated.
Chave de teste também envia de verdade
zz_test_ e zz_live_ são rótulos para você não misturar sistemas: as duas chaves acessam a mesma conta, enviam mensagens reais e consomem saldo. Para testar sem incomodar ninguém, envie para o seu próprio número.
Próximos passos
API do Zynzap
Envie e receba mensagens de WhatsApp, opere o atendimento, o CRM e as campanhas do Zynzap a partir do seu sistema, com chaves de permissão mínima, webhooks assinados e custo conhecido antes de cada envio.
Autenticação
Chaves de API com permissões mínimas, ambientes, números e IPs permitidos, limite próprio, validade, rotação sem parada e revogação.