> ## Documentation Index
> Fetch the complete documentation index at: https://docs-hub-campaign.convertt.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> API RESTful para disparo programático de campanhas RCS via Convertt

# RCS Convertt API

A API da Convertt permite que você dispare campanhas RCS de forma programática, sem precisar usar o dashboard web. Integre diretamente com seus sistemas internos para automação de campanhas.

## O que você pode fazer

<CardGroup cols={2}>
  <Card title="Disparar Campanhas" icon="rocket">
    Envie campanhas RCS para até 2.000 destinatários por chamada, com validação automática de números e variáveis de template.
  </Card>

  <Card title="Receber Status" icon="bell">
    Configure webhooks para receber notificações em tempo real sobre o status de entrega das mensagens (delivered, read, clicked, etc.).
  </Card>

  <Card title="OAuth 2.0" icon="lock">
    Autenticação segura via OAuth 2.0 com client credentials e refresh tokens.
  </Card>

  <Card title="Rastreamento em Tempo Real" icon="chart-line">
    Acompanhe o status de cada mensagem (enviada, entregue, lida, clicada) com precisão de milissegundos via webhooks ou pelo dashboard.
  </Card>
</CardGroup>

## Fluxo Básico

```mermaid theme={null}
sequenceDiagram
    participant Client as Seu Sistema
    participant API as Convertt API
    participant Cliente as Cliente
    participant Webhook as Seu Webhook

    Client->>API: POST /oauth/token (credentials)
    API-->>Client: access_token + refresh_token

    Client->>API: POST /external/campaigns/dispatch
    API-->>Client: 202 Accepted (campaignId)

    API->>Cliente: Envia mensagens RCS
    Cliente-->>API: Atualizações de status (delivered, read...)

    API->>Webhook: POST (message.status_updated)
    Webhook-->>API: 200 OK
```

## Ambientes

| Ambiente | Base URL                                       |
| -------- | ---------------------------------------------- |
| Produção | `https://api-hub-campaign.convertt.ai/api/v1/` |

## Rate Limits

| Endpoint                            | Limite                |
| ----------------------------------- | --------------------- |
| `POST /oauth/token`                 | 10 req/min por IP     |
| `POST /external/campaigns/dispatch` | 60 req/min por tenant |

## Próximos Passos

<CardGroup cols={2}>
  <Card title="Primeiros Passos" icon="play" href="/guides/getting-started">
    Configure suas credenciais e faça o primeiro disparo em menos de 5 minutos.
  </Card>

  <Card title="Autenticação" icon="key" href="/authentication">
    Entenda como funciona o OAuth 2.0 na API.
  </Card>
</CardGroup>