Documentação da API
A API RESTful da SendSync permite orquestrar comunicações multicanal (WhatsApp e E-mail) com filas inteligentes, priorização automática e redundância.
Alta Performance
Projetada para suportar +1000 RPM (requisições por minuto) com processamento assíncrono via Redis.
Webhooks (Em Breve)
Receba atualizações em tempo real sobre entrega, leitura e respostas dos clientes.
Autenticação
Todas as requisições API devem ser autenticadas usando um Bearer Token no header HTTP. Você pode obter suas chaves de API no Painel de Controle.
Segurança Crítica
Nunca exponha sua chave secreta em código client-side (navegador). Realize chamadas apenas do seu servidor backend.
Authorization: Bearer sk_live_51M3...Base URL
Todos os endpoints são relativos à URL base abaixo:
Enviar Mensagem Unitária
Adiciona uma mensagem à fila de processamento. Este endpoint é ideal para notificações transacionais (OTP, confirmação de pedido). Nota: Se for enviar anexos, utilize o formato multipart/form-data. Para mensagens simples apenas de texto, você pode usar application/json.
Parâmetros do Body
connectorIdstringOBRIGATÓRIOID do conector (instância WhatsApp) que realizará o envio.
tostringOBRIGATÓRIONúmero de destino completo (DDI + DDD + Número) apenas dígitos.
Ex: 5511999998888
messagestringOBRIGATÓRIOConteúdo da mensagem. Suporta formatação Markdown do WhatsApp.
messageTypestringTipo/categoria da mensagem. Valores: GERAL (padrão), NOTIFICATION, MARKETING, TRANSACTIONAL, SUPPORT, REMINDER.
Ex: TRANSACTIONAL
forceDirectbooleanOpte por true para pular a fila de prioridade normal (use com cautela).
attachmentsfile[]Arquivos para anexar à mensagem. Requer envio via multipart/form-data. Limite: 50MB por arquivo.
Exemplo de Requisição
curl -X POST https://api.sendsync.com/api/messages/send \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"connectorId": "con_123456",
"to": "5511999998888",
"message": "Olá *Cliente*, seu pedido foi confirmado!",
"messageType": "TRANSACTIONAL"
}'
# Exemplo com Anexo (Multipart)
curl -X POST https://api.sendsync.com/api/messages/send \
-H "Authorization: Bearer SEU_TOKEN" \
-F "connectorId=con_123456" \
-F "to=5511999998888" \
-F "message=Segue o comprovante" \
-F "attachments=@/caminho/do/arquivo.pdf"Resposta de Sucesso (201 Created)
{
"id": "msg_01HQ...",
"status": "queued",
"priority": 1,
"queuePosition": 42
}Envio em Massa
Permite enviar até 1000 mensagens em uma única requisição HTTP. Altamente recomendado para campanhas de marketing para reduzir overhead de rede.
curl -X POST https://api.sendsync.com/api/messages/bulk \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"messages": [
{ "connectorId": "c1", "to": "5511999...", "message": "Msg 1", "messageType": "MARKETING" },
{ "connectorId": "c1", "to": "5511988...", "message": "Msg 2", "messageType": "MARKETING" }
]
}'Listar Fila de Mensagens
Retorna as últimas 100 mensagens da fila. Útil para monitorar o status de envios ou construir um dashboard personalizado.
Query params
statusenumFiltra mensagens pelo status atual. Se omitido, retorna todos.
Ex: PENDING, WAITING, PROCESSING, SENT, FAILED, CANCELED
pageintegerNúmero da página para paginação. Padrão: 1
Ex: 1
limitintegerQuantidade de itens por página. Padrão: 250
Ex: 250
Exemplo de Requisição
curl -X GET "https://api.sendsync.com/api/messages/queue?page=1&limit=250" \
-H "Authorization: Bearer TOKEN"Exemplo de Resposta
{
"data": [
{
"id": "...",
"to": "5511...",
"attachments": [
{
"url": "https://api.../uploads/file.pdf"
}
]
}
],
"meta": {
"total": 1050,
"page": 1,
"limit": 250,
"pages": 5
}
}Listar Conectores
Retorna todos os conectores configurados (WhatsApp, Email, Telegram) com seus IDs e status.
curl -X GET "https://api.sendsync.com/connectors" \
-H "Authorization: Bearer TOKEN"Conectar Sessão WhatsApp
Inicia o processo de conexão e retorna o QR Code (em base64) para ser escaneado pelo aplicativo.
curl -X POST https://api.sendsync.com/whatsapp/connect/con_123 \
-H "Authorization: Bearer TOKEN"Guia: Prevenção de Bloqueios
Spintax & Variáveis
Jamais envie o mesmo texto hash idêntico para milhares de pessoas. Use variações como 'Olá', 'Oi', 'Tudo bem' e inclua o nome do cliente.
Limitadores de Velocidade
Comece devagar. O sistema aplica delay aleatório (min-max) entre mensagens, mas respeite o limite de aquecimento do chip.
Saúde do Chip (Health Score)
O WhatsApp monitora interações. Se você envia 1000 msgs e recebe 0 respostas (ou muitos bloqueios), seu score cai.
Warm-up Gradual
Dia 1: 50 msgs. Dia 2: 100 msgs. Dia 3: 200 msgs. Aumente 30-50% ao dia até o volume desejado.