Disparly

API pública Disparly

Integre sistemas externos (ERP, CRM, automações) ao seu workspace via REST + Bearer token. Versão v1.

OpenAPI JSONGerar API key no painel

Base URL

https://disparly.com

Autenticação

Crie uma chave em Espaço → API (owner/admin). O token completo é mostrado uma única vez.

Authorization: Bearer dsp_live_…

Escopos: read, write, campaigns. O workspace precisa de assinatura active.

Rate limit

  • ~60 req/min por API key
  • ~120 req/min por IP
  • Resposta 429 com header Retry-After

Endpoints

GET/api/v1/mescope: read

Workspace, plano e uso atual.

GET/api/v1/contactsscope: read

Lista contatos. Query: limit, cursor, q.

POST/api/v1/contactsscope: write

Cria ou atualiza contato. Body: phone (obrigatório), name, email, optIn.

GET/api/v1/templatesscope: read

Modelos de mensagem. Query: status=APPROVED.

GET/api/v1/listsscope: read

Listas de audiência (para campanhas).

GET/api/v1/channelsscope: read

Canais WhatsApp (sem expor token).

GET/api/v1/campaignsscope: read

Lista campanhas.

POST/api/v1/campaignsscope: campaigns

Cria campanha. Body: name, listId, templateId, channelId, start?

Exemplos

Workspace

curl -sS -H "Authorization: Bearer dsp_live_SEU_TOKEN" \
  https://disparly.com/api/v1/me

Criar contato

curl -sS -X POST \
  -H "Authorization: Bearer dsp_live_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"phone":"5511999999999","name":"Ana","optIn":true}' \
  https://disparly.com/api/v1/contacts

Criar e iniciar campanha

curl -sS -X POST \
  -H "Authorization: Bearer dsp_live_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Black Friday",
    "listId": "…",
    "templateId": "…",
    "channelId": "…",
    "start": true
  }' \
  https://disparly.com/api/v1/campaigns

Erros

  • 401 — key ausente/inválida
  • 403 — escopo insuficiente ou assinatura inativa
  • 400 — validação
  • 429 — rate limit
{ "ok": false, "error": "mensagem em pt-BR" }

Dúvidas: contato@disparly.com