1. Whatsapp
Documentação técnica das API do Messagefy
  • Introdução
  • Começando
  • Guia de Integração
  • Collections Postman
  • OnBoarding
    • OnBoarding para Organizações
  • Me
    • Introdução
    • Sobre
      GET
  • Contas
    • Introdução
    • Criar conta
      POST
    • Listar contas
      GET
    • Buscar por id
      GET
    • Atualizar conta
      PUT
    • Deletar conta
      DELETE
  • API Key
    • Introdução
    • Criar apikey
    • Listar ApiKeys
    • Buscar por ID
    • Atualizar apikey
    • Deletar apiKey
  • Administrando Canais
    • Introdução
    • WebHook
      • Criar canal de Webhook
    • Whatsapp
      • Criar canal de Whatsapp
        POST
      • Status do Canal Whatsapp
        POST
      • Solicitar QRCode
        POST
      • Solicitar Pair Code
        POST
      • Solicitar Desconectar o número
        POST
    • Outbox
      • Listar Mensagens no Outbox do Canal
      • Obter detalhes da Mensagem no Outbox do Canal
      • Reenviar Múltiplas Mensagens no Outbox do Canal
      • Cancelar Mensagem no Outbox do Canal
    • Listar canais
      GET
    • Buscar por id
      GET
    • Atualizar canal
      PUT
    • Deletar canal
      DELETE
    • Transferir canal
      POST
  • Usando o Canal Whatsapp
    • Introdução
    • Contatos e Grupos
      • Solicitar contatos
      • Solicitar informações do contato
      • Solicitar grupos
      • Solicitar presença de contato (online/offline)
      • Solicitar Chats
      • Solicitar informação do grupo
    • Enviando Mensagens
      • Texto, imagem, audio, video, documentos e sticker
      • Enviar contatos
      • Enviar lista de contato
      • Marcar mensagens como lida
    • Excluindo e Editando Mensagens
      • Apagar mensagem para todos
      • Editar mensagem
    • Recuperar Messagens Antigas
  • Recebendo WebHooks
    • Guia Completo de WebHooks
    • Mensagens Recebidas
      • TEXT
      • CONTACT_MESSAGE
      • CONTACTS_MESSAGE
    • Status do canal
    • QRCode gerado retorno
    • Lista de contatos
    • Lista de grupos
    • Mensagem entregue
    • Mensagem lida
    • Download Disponivel
    • Localização e Localização em tempo real
    • Lista de Histórico
    • Ligação recebida e realizada
    • Lista de contatos do grupo
    • Lista de chats
    • Alteração de Grupo
  • Raiz
  • Esquemas
    • Eventos de WebHook
      • Eventos de Conexão
        • PAIR_CODE_GENERATED_RESPONSE: PairCode de conexão
        • INSTANCE_USER_CONNECT_TIMEOUT: Usuário não realizou Login
        • DISCONNECTED: Celular desconectado
        • CONNECTED: Celular conectado
      • Eventos de Mensagens
        • EchoMessage: Eco de Mensagem enviada
      • Eventos de Status de Mensagens
        • MESSAGE_SENT: Mensagem enviada
        • MESSAGE_DELIVERED: Mensagem entregue
        • MESSAGE_READ: Mensagem lida
    • ContatoWhatsapp
    • ContactResponseInfo
    • AccountResponse
    • Organization
    • ResourcePlanResponse
    • ChannelType
    • ChannelStatus
    • Provider
  1. Whatsapp

Solicitar QRCode

dev
https://api-dev.messagefy.io
dev
https://api-dev.messagefy.io
POST
/api/v1/message/sendcommand
Este método solicita um QRCode (imagem do base64).
Você pode renderizá-la em um componente do tipo imagem compatível com sua plataforma.
Assim como no WhatsApp Web, você precisará ler um código QR com a câmera do dispositivo para se conectar o whatsapp ao MessageFy!
O MessageFy envia os dados automaticamente para o seu endpoint via webhook. Consulte a seção Recebendo webhooks.
QrCode Expirado: Caso o QrCode recebido pelo webhook leve muito tempo (mais que 30 segundos) para ser lido (pelo dispositivo), um novo QrCode é gerado. A janela de tempo total para a autenticação é de aproximadamente 160 segundos, após isso, é necessário solicitar o QRCode novamente via API.
Sessão de Login Expirada: Após algum tempo (definido pela Meta), o MessageFy encaminha uma mensagem de desconexão, informando que a sessão de login terminou. Nesse caso envie novamente essa mensagem.
Caso queira consulta o status da conexão, use a Mensagem:
{
    "channelId": "019be0cb-e7f8-706f-9350-a92ce33ad5bf",
    "content": {
        "type": "STATUS",
        "commandType": "STATUS",
        "enableHistoryOnConnect": false
    }
}

Requisição

Authorization
Adicionar parâmetro em header
api-key
Exemplo:
api-key: ********************
Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso
application/json
Você pode usar o originPackageId no result para relacionar o seu Request com o Result que foi entregue no WebHook
Body

🟢200WebHook
🟠400Erro
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-dev.messagefy.io/api/v1/message/sendcommand' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channelId": "019c2dbd-f72e-78d6-93ce-da9249de70b9",
    "correlationId": "Meu identificador de correlação",
    "content": {
        "commandType": "SESSION_START",
        "type": "SESSION_START_QR_CODE",
        "enableHistoryOnConnect": false,
        "historyMessageLimit": 50,
        "historyDateLimit": "2026-01-01"
    }
}'
Response Response Example
200 - Exemplo
{
    "packageId": "6bfd910d-6247-6f46-471a-ae0692e7402e"
}
Modificado em 2026-04-02 11:35:56
Página anterior
Status do Canal Whatsapp
Próxima página
Solicitar Pair Code
Built with