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

# Introdução

> Bem-vindo à documentação da API MessageFy — plataforma de mensageria multi-canal

# MessageFy API

MessageFy é uma plataforma de mensageria multi-canal que permite enviar e receber mensagens via
**WhatsApp**, **HTTP Webhook**, tudo através de uma API REST unificada.

## O que é possível fazer?

<CardGroup cols={2}>
  <Card title="Enviar Mensagens" icon="paper-plane" href="/mensagens/visao-geral">
    Texto, imagens, documentos, áudio, vídeo, localização, contatos e mais.
  </Card>

  <Card title="Gerenciar Sessões" icon="plug" href="/comandos/iniciar-sessao">
    Conecte dispositivos WhatsApp via QR Code ou código de pareamento.
  </Card>

  <Card title="Administrar Recursos" icon="gear" href="/api-reference/visao-geral">
    Crie e gerencie organizações, contas, canais e API keys.
  </Card>
</CardGroup>

## Como funciona

<Steps>
  <Step title="Crie uma Organização e Conta">
    Organize seus recursos em organizações e contas. Cada conta pode ter múltiplos canais.
  </Step>

  <Step title="Crie um Canal">
    Um canal representa uma conexão com um provedor de mensageria (ex: um número WhatsApp).
    Configure o tipo de canal e a URL de webhook para receber eventos.
  </Step>

  <Step title="Gere uma API Key">
    A API key autentica suas requisições. Cada key está vinculada a uma conta e pode ter
    limites de uso (rate limiting).
  </Step>

  <Step title="Envie e Receba Mensagens">
    Use `POST /api/v1/message/SendMessage` para enviar e configure webhooks para receber.
  </Step>
</Steps>

## Fluxo de Mensagens

```text theme={null}
Sua Aplicação                    MessageFy                      WhatsApp
     │                              │                              │
     │── POST /SendMessage ────────>│                              │
     │<── { packageId } ───────────│                              │
     │                              │── Envia mensagem ──────────>│
     │                              │                              │
     │                              │<── Mensagem entregue ───────│
     │<── Webhook MESSAGE_DELIVERED │                              │
     │                              │                              │
     │                              │<── Mensagem recebida ───────│
     │<── Webhook TEXT/IMAGE/... ───│                              │
```

## Ambientes

| Ambiente        | URL                            |
| --------------- | ------------------------------ |
| Desenvolvimento | `https://api-dev.messagefy.io` |
| Staging         | `https://api-stg.messagefy.io` |
| QA              | `https://api-qa.messagefy.io`  |
| Produção        | `https://api-prd.messagefy.io` |

## Próximos Passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="lock" href="/autenticacao">
    Configure sua API key e entenda os headers de segurança.
  </Card>

  <Card title="Quick Start" icon="rocket" href="/quick-start">
    Envie sua primeira mensagem em 5 minutos.
  </Card>
</CardGroup>