Skip to main content

Endpoint

GET /v1/broadcasts
Escopo necessário: read:broadcasts — disponível nos planos Growth e Scale.

Exemplo de requisição

curl "https://api.socialsell.ai/v1/broadcasts" \
  -H "Authorization: Bearer sk_live_..."

Exemplo de resposta

{
  "data": [
    {
      "id": "664t3s4t5u6v7w8x9y0z1a2b",
      "name": "Black Friday 2026",
      "status": "running",
      "whatsapp_instances": [
        { "id": "664h...", "name": "WhatsApp Principal", "phone": "+5511333344445", "status": "connected" }
      ],
      "audience": { "type": "tags", "tags": ["cliente"], "estimatedCount": 1250 },
      "message": { "type": "text", "text": "🔥 Black Friday! 50% OFF..." },
      "send_config": { "profile": "balanced" },
      "stats": { "sent": 800, "delivered": 760, "read": 520, "failed": 12 },
      "started_at": "2026-06-10T09:00:00.000Z",
      "completed_at": null,
      "created_at": "2026-06-09T18:00:00.000Z"
    }
  ],
  "meta": { "total": 8, "has_more": false }
}

Objeto disparo

CampoTipoDescrição
idstringID do disparo
namestringNome da campanha
statusstringdraft, scheduled, running, paused, completed, cancelled
whatsapp_instancesarrayInstâncias usadas no envio
audienceobjectSegmentação da audiência
messageobjectConteúdo da mensagem
send_configobjectPerfil e configuração de envio
statsobjectMétricas: sent, delivered, read, failed
started_at / completed_at / paused_at / cancelled_atstring|nullTimestamps do ciclo