API e webhooks para WhatsApp e Telegram
Envie mensagens do WhatsApp e do Telegram por uma API REST e receba cada mensagem e cada mudança de status por webhook, para integrar seus canais ao seu sistema. Instagram em breve. Incluído no plano de R$ 19,90 por canal ao mês.
Criar contaO que dá para fazer
Enviar mensagens
No WhatsApp e no Telegram: texto, mídia (imagem, vídeo, áudio, documento e figurinha), localização, contato e enquete, por uma chamada REST; os tipos disponíveis variam por canal. Cada envio leva uma referência própria: repetir a chamada com a mesma referência e o mesmo corpo não envia duas vezes.
Receber eventos por webhook
Cadastre uma URL HTTPS e receba mensagens recebidas, status de entrega e leitura, mudanças de conexão e outros eventos assim que acontecem. Cada webhook tem um segredo para você conferir a assinatura.
Agendar mensagens
Programe uma mensagem para um horário futuro e acompanhe o resultado pelo evento de mensagem agendada.
Um token, vários canais
O mesmo token da organização vale para todos os canais. Você escolhe o canal pelo ID na rota e pode restringir um webhook a um canal só.
Como começar
- 1. PassoGere o token no consoleNa página API do console, gere o token da organização. Guarde-o no servidor, nunca no navegador ou no app, e envie-o em toda chamada no cabeçalho Authorization.
- 2. PassoCopie o ID do canalA mesma página lista os canais da organização, cada um com o seu ID, e mostra o endereço da API. O ID do canal entra na rota de mensagens.
- 3. PassoChame a APIFaça o primeiro envio com o exemplo abaixo e cadastre um webhook para acompanhar o que acontece com a mensagem.
Enviar uma mensagem
Uma chamada POST na rota de mensagens do canal, seja de WhatsApp ou de Telegram. O campo to aceita o telefone com código do país (no Telegram, também o @usuário), e clientRef é a referência do envio: repetir a chamada com a mesma referência e o mesmo corpo não envia duas vezes, e um corpo diferente com a mesma referência é recusado. Guarde o token na variável WAPLYR_TOKEN e troque os valores entre sinais de menor e maior pelos seus.
curl -X POST "https://<sua-api>/v1/instances/<ID_DO_CANAL>/messages" \
-H "Authorization: Bearer $WAPLYR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "text",
"to": "<TELEFONE_COM_DDI>",
"text": "Olá! Seu pedido saiu para entrega.",
"clientRef": "pedido-1042-aviso"
}'Eventos de webhook
| Evento | Quando acontece |
|---|---|
| connection.update | O estado da conexão do canal mudou, por exemplo de conectado para reconectando. |
| message.received | Chegou uma mensagem de um contato. |
| message.sent | Uma mensagem do canal foi enviada, inclusive as enviadas de outro aparelho da conta. |
| message.status | O status de uma mensagem avançou: enviada, entregue, lida, reproduzida ou com falha. |
| message.updated | Uma mensagem já publicada mudou, por exemplo mídia, estrela, fixação ou votos de enquete. |
| message.edited | Uma mensagem foi editada. |
| message.deleted | Uma mensagem foi apagada. |
| message.reaction | Uma reação foi adicionada, trocada ou removida de uma mensagem. |
| scheduled_message.updated | Uma mensagem agendada foi criada, alterada, cancelada, enviada ou falhou. |
| contact.updated | O nome, o telefone ou a foto de perfil de um contato mudou. |
| contact.lid_mapped | O identificador (LID) de um contato do WhatsApp foi associado ao telefone dele. |
| conversation.updated | Uma conversa mudou, por exemplo nova última mensagem, leitura, arquivamento, fixação, silenciamento, bloqueio ou etiquetas. |
| conversation.history_fetched | O resultado de um pedido de histórico de uma conversa chegou: concluído ou sem resposta a tempo. |
| label.updated | Uma etiqueta da conta WhatsApp Business foi criada, renomeada, recolorida ou apagada. |
| * | Todos os eventos públicos, os atuais e os que vierem a existir. |
Incluído no plano
A API e os webhooks fazem parte do plano de R$ 19,90 por canal ao mês, sem custo extra por mensagem. Não há plano separado para desenvolvedores nem limite de atendentes.
Documentação completa
A documentação pública lista cada rota, os campos de cada corpo de requisição, os códigos de resposta e o formato de cada evento.
Comece a integrar o Waplyr ao seu sistema
Crie sua conta, conecte um canal e gere o token. API e webhooks incluídos no plano de R$ 19,90 por canal ao mês.