Guia de Integração

Antes de começar, é importante entender como a MessageFy organiza seus recursos

Fluxo Simplificado

Organization (MessageFy) → Sua empresa se cadastra na plataforma

Account (Vendas, suporte) → Cria departamentos/times dentro da empresa

API Key → Recebe credencial para autenticar requisições

Channels → Cria canais de comunicação

Send Messages → Envia mensagens através dos canais

Delivery → Processa mensagens de forma assíncrona

Principais Operações

1. Accounts

💡

Uma Account é uma divisão dentro da sua organização. Por exemplo, a MessageFy pode ter contas separadas para "Vendas" e "Suporte".

POST /api/v1/admin/account

{
    "name": "Suporte",
    "description": "Pós venda",
    "organizationId": "org_123"
}

2. API Keys

💡

As API Keys são usadas para autenticar suas requisições. Cada organization recebe uma chave inicial na criação.

POST /api/v1/admin/apikey

{
    "name": "Suporte Key",
    "description": "Key da conta de suporte",
    "accountId": "account-id"
}

3. Channels

💡

Um Channel é um canal de comunicação (WhatsApp, Webhook, etc.). Vamos criar dois canais para a MessageFy: um WhatsApp e um Webhook.

3.1 Criar Canal Webhook

📌

Trabalhamos de forma assíncrona, e necessário primeiro um webhook para você receber todas as solicitações

POST /api/v1/admin/channel

{
    "name": "Suporte webhook",
    "description": "webhook feedback",
    "channelType": "http-sender",
    "accountId": "account-id",
    "parameters": {
        "url": "https://SUAEMPRESA.com.br/api/messagefy/receive"
    }
}

3.2 Criar Canal WhatsApp

POST /api/v1/admin/channel

{
    "name": "Whatsapp Web",
    "description": "whatsapp não oficial",
    "channelType": "whatsapp-web",
    "accountId": "account-id",
    "parameters": {
        "url": "https://SUAEMPRESA.com.br/api/messagefy/receive"
    },
    "**feedbackChannelId**": "webhook-id"
}

feedbackChannelId: "webhook-id" criado no item 3.1 na resposta

4. Enviando Mensagens

Agora que temos nossos canais configurados, vamos enviar mensagens!

Solicite um QRcode e você vai receber via webhook

1. POST /api/v1/message/sendmessage

{
   "channelId": "your-channel-id",
   "content": {
      "type": "SESSION_START_QR_CODE",
      "commandType": "SESSION_START"
   }
}

2. POST /api/v1/message/sendmessage

{
  "channelId": "webhook-whatsapp-web-id",
  "content": {
    "type": "TEXT",
    "to": {
      "type": "WHATSAPP",
      "id": "55XX00000000"
    },
    "text": "Olá! Sua demonstração foi agendada para amanhã às 14h. Confirma"
  }
}

POST /api/v1/message/sendmessage

{
  "channelId": "webhook-whatsapp-web-id",
  "content": {
    "type": "TEXT",
    "to": {
      "type": "WHATSAPP",
      "id": "55XX00000000"
    },
    "text": "Olá! Sua demonstração foi agendada para amanhã às 14h. Confirma"
  }
}

Resposta

{
  "packageId": "pkg_abc123def456"
}

O packageId pode ser usado para rastrear o status da mensagem

Fluxo Simplificado#

Principais Operações#

1. Accounts#

POST /api/v1/admin/account#

2. API Keys#

POST /api/v1/admin/apikey#

3. Channels#

3.1 Criar Canal Webhook#

POST /api/v1/admin/channel#

3.2 Criar Canal WhatsApp#

POST /api/v1/admin/channel#

4. Enviando Mensagens#

1. POST /api/v1/message/sendmessage#

2. POST /api/v1/message/sendmessage#

POST /api/v1/message/sendmessage#

Fluxo Simplificado

Principais Operações

1. Accounts

POST /api/v1/admin/account

2. API Keys

POST /api/v1/admin/apikey

3. Channels

3.1 Criar Canal Webhook

POST /api/v1/admin/channel

3.2 Criar Canal WhatsApp

POST /api/v1/admin/channel

4. Enviando Mensagens

1. POST /api/v1/message/sendmessage

2. POST /api/v1/message/sendmessage

POST /api/v1/message/sendmessage