Referência da API
Enviar mensagem
Contrato completo para texto, mídia, localização e templates.
POST
/api/v1/messagesEnvia texto, mídia, localização ou template. Em canais não oficiais, a Vensy pode selecionar automaticamente um cartucho apto; canais Cloud exigem template.
Autorização
bearerAuth AuthorizationBearer <token>
API key criada em Configurações → Chaves de API. Formato: vsk_live_…
In: header
Parâmetros de cabeçalho
Idempotency-Key?string
Chave única por operação. Reutilize-a com o mesmo payload em retries.
Tamanho
8 <= length <= 128Prefer?"respond-async"
Envie respond-async para receber 202 sem aguardar o provedor.
Valores permitidos
- "respond-async"
Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
Corpo da resposta
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/messages" \ -H "Content-Type: application/json" \ -d '{ "to": "+5511999999999", "type": "text", "text": "Olá! Sua solicitação foi recebida." }'{ "messageId": "string", "providerMessageId": "string", "outreachId": "string", "firingChannelId": "string", "conversationId": "string", "status": "sent", "createdAt": "2019-08-24T14:15:22Z", "idempotencyReplayed": true, "apiKeyId": "string"}