CONSTRUÍDA PARA QUEM CONSTRÓI

Uma API para todos os canais: RCS, WhatsApp, SMS e voz

Envie mensagens em qualquer canal com o mesmo endpoint e o mesmo payload — o canal é só um parâmetro. Receba status de entrega e respostas por webhooks assinados e acompanhe cada requisição nos logs.

  • Integração por API e painel
  • Contexto compartilhado com o Nexfy Desk
  • Relatórios em tempo real
POST /v1/messages
const res = await fetch("https://api.nexfy.com/v1/messages", {  method: "POST",  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },  body: JSON.stringify({    channel: "whatsapp",   // "rcs" | "sms" | "voice"    to: "+5511999999999",    template: "pedido_confirmado",    variables: { pedido: "1042", entrega: "amanhã" }  })});const { id, status } = await res.json(); // "msg_01H…", "queued"

Exemplo conceitual. O contrato de API definitivo é disponibilizado para a sua operação.

POR QUE API

Por que integrar pela API da Nexfy

Um endpoint, vários canais

POST /v1/messages com channel = rcs, whatsapp, sms ou voice. Menos código, menos integrações para manter.

Webhooks assinados

Eventos de entrega (DLR), leitura, clique e mensagens recebidas chegam ao seu sistema com assinatura para validação.

Controle por ambiente

Chaves separadas para teste e produção, permissões por chave e logs de cada requisição para auditoria.

COMO FUNCIONA

Como funciona, passo a passo

Da chave de API ao webhook: o caminho para colocar a integração em produção.

Desenhar minha jornada
  1. 01AUTENTIQUEChave de APIGere chaves no painel com escopo por ambiente e permissões. Envie no header Authorization: Bearer.
  2. 02ENVIEPOST /v1/messagesInforme canal, destinatário e conteúdo (texto, template ou mídia). A resposta traz o id e o status inicial.
  3. 03RECEBAWebhooksCadastre a URL para eventos de status e mensagens recebidas; valide a assinatura e processe de forma idempotente.
  4. 04OPERELogs e limitesConsulte requisições, erros e consumo no painel; configure limites e alertas por chave.
CASOS DE USO

Onde a API faz diferença

  • Plataformas de e-commerce

    Confirmação de pedido, rastreio e recuperação de carrinho disparados por eventos.

  • Autenticação

    OTP por SMS ou WhatsApp no fluxo de login e cadastro do seu produto.

  • SaaS e sistemas internos

    Notificações do produto por canal preferido do usuário.

  • Contact centers

    Integração do Nexfy Desk com CRM e ferramentas de ticket.

RECURSOS

O que está incluído

Recursos disponíveis conforme os canais e o plano contratados. Fale com um especialista para desenhar a configuração ideal para a sua operação.

Ver a API para desenvolvedores
  • API REST com JSON e HTTPS
  • Endpoint único para RCS, WhatsApp, SMS e voz
  • Templates com variáveis
  • Webhooks assinados (entrega, leitura, clique, resposta)
  • Idempotência por chave de requisição
  • Ambiente de testes sem envio real
  • Logs por requisição e por chave
  • Exemplos em JavaScript, Python e cURL
PERGUNTAS FREQUENTES

Dúvidas sobre a API

Como recebo a confirmação de entrega?

Por webhook. Cada mudança de status (enfileirada, enviada, entregue, lida, falha) gera um evento assinado para a URL cadastrada. Também é possível consultar o status pelo id da mensagem.

Existe ambiente de testes?

Sim. Chaves de teste permitem validar a integração sem envio real; os eventos de webhook são simulados para o seu endpoint.

Como funciona a idempotência?

Envie um identificador único por requisição no header; requisições repetidas com o mesmo identificador não geram novos envios.

Quais limites de envio existem?

Os limites dependem dos canais e do plano contratado e podem ser configurados por chave. Acima do limite, a API responde com o código apropriado e o tempo sugerido para nova tentativa.

VAMOS CONVERSAR

Pronto para integrar a API da Nexfy?

Conte sobre sua operação e receba uma proposta sob medida por canais, volume e integração.

Ou escreva para contato@nexfy.com