Manual de integração
Documentação simples e completa para você ganhar agilidade em sua implementação.
Nesta introdução você encontra uma visão geral da API e como começar rapidamente.
Práticas de SPAM
CUIDADO! Você pode ter o seu número bloqueado e/ou banido.
Não realize práticas relacionadas a SPAM.
NÃO envie mensagens que não foram solicitadas.
Dê preferência a usar números que os seus clientes já estão acostumados a falar com você.
Limite de requests na API
Por motivo de segurança, controlamos a quantidade e a origem dos requests em nossa API.
Você pode fazer no máximo 50 requests a cada 10 segundos.
Códigos de retorno HTTP
A API retorna respostas em JSON e utiliza códigos HTTP para indicar sucesso ou erro. Abaixo estão os códigos mais comuns e o que fazer em cada caso.
| Código | O que significa | Sugestão para o cliente |
|---|---|---|
200 |
OK (requisição processada com sucesso). | Trate como sucesso e utilize os dados retornados no JSON. |
201 |
Created (operação de criação/envio concluída com sucesso). | Trate como sucesso. Armazene o identificador retornado quando existir. |
400 |
Bad Request (requisição inválida, parâmetro inválido ou header obrigatório ausente). | Revise headers e parâmetros. Para POST/PUT/DELETE, envie content-type application/json e inclua o header apiKey. |
403 |
Forbidden (acesso negado ou acesso bloqueado por tentativas inválidas). | Verifique a API Key. Se houver bloqueio, aguarde o tempo de desbloqueio e evite repetir requisições inválidas. Se persistir, contate o suporte. |
404 |
Not Found (recurso não encontrado). | Confirme se os identificadores/tokens informados existem (ex.: chat_wid, access_token) e se o recurso ainda está disponível. |
405 |
Method Not Allowed (método HTTP incorreto para o endpoint). | Use o método indicado na documentação (GET/POST/PUT/DELETE). |
409 |
Conflict (conflito de estado, geralmente por duplicidade). | Não faça retry automático sem validar. Ajuste o fluxo para atualizar o recurso existente ou evitar duplicidade. |
422 |
Unprocessable Entity (falha de validação: campos obrigatórios ausentes ou inconsistentes). | Preencha os campos obrigatórios conforme o endpoint. Use a mensagem retornada (msg) para identificar o campo faltante. |
500 |
Internal Server Error (erro inesperado ao processar a requisição). | Tente novamente com backoff. Se persistir, registre request/response (sem dados sensíveis) e contate o suporte. |
Em alguns erros (como content-type inválido ou ausência de API Key), tentativas repetidas podem gerar bloqueio temporário do acesso.
Fila de entrega
Geramos uma fila de entrega automaticamente para facilitar sua integração. Assim, você não precisa gerenciar filas no seu código.
Você pode gerenciar a velocidade da fila em Limite de processamento de mensagens por minuto no menu Canais de atendimento.
Precisa entregar mensagens em tempo real?
Adicione no header do seu request o parâmetro toTransmit: true
para que a mensagem seja entregue no momento do envio, sem passar pela fila.
Parâmetro chat_wid
O parâmetro chat_wid representa o número ou identificação de uma conversa. Para verificar se um número é válido, use o método Ferramentas/have-whatsapp no Postman ou acesse: https://croncrm.com/api/v2/tools/have-whatsapp.
Postman
Ferramenta gratuita e completa que permite testar sua integração sem escrever código para cada método da API.
VisualizarPrecisa de ajuda?
Conte com nosso time de programadores para ajudar na sua integração.