Início rápido
Faça o primeiro disparo e consulte a entrega.
1. Crie uma API key
No app da Vensy, abra Configurações → Chaves de API e selecione Nova chave. O segredo começa com vsk_live_ e aparece uma única vez.
Guarde a chave com segurança
Salve o segredo em um cofre de credenciais ou variável de ambiente. Não coloque a chave em frontend, aplicativo móvel, repositório ou log.
2. Envie uma mensagem
curl --request POST 'https://vensy.com.br/api/v1/messages' \
--header "Authorization: Bearer $VENSY_API_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $(uuidgen)" \
--data '{
"to": "+5511999999999",
"type": "text",
"text": "Olá! Sua solicitação foi recebida."
}'Uma resposta síncrona bem-sucedida usa 200. Quando você envia Prefer: respond-async, a API pode responder 202 com status: "queued".
{
"messageId": "3EB0A1B2C3",
"providerMessageId": "3EB0A1B2C3",
"outreachId": "cm_outreach_123",
"firingChannelId": "cm_channel_123",
"conversationId": null,
"status": "sent",
"createdAt": "2026-08-27T18:30:00.000Z",
"idempotencyReplayed": false,
"apiKeyId": "cm_key_123"
}3. Consulte o status
Use o providerMessageId retornado no envio:
curl 'https://vensy.com.br/api/v1/messages/3EB0A1B2C3' \
--header "Authorization: Bearer $VENSY_API_KEY"Os estados públicos são sent, delivered, read e failed. Veja Status de entrega para definir sua estratégia de polling.