1. Recebendo WebHooks
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
      • Status do Canal Whatsapp
      • Solicitar QRCode
      • Solicitar Pair Code
      • Solicitar Desconectar o número
    • 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
    • Buscar por id
    • Atualizar canal
    • Deletar canal
    • Transferir canal
  • 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. Recebendo WebHooks

Ligação recebida e realizada

Webhook
POST
Ligação recebida ou realizada
A informação referente às ligações, sejam recebidas ou realizadas, será retornada na estrutura.
Atenção: esta funcionalidade disponibiliza apenas os dados das ligações (recebidas ou realizadas); não sendo possível realizar ou receber chamadas por meio dela.

Requisição

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

Respostas

🟢200Sucesso
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-api-server.com' \
--header 'api-key: <api-key>'
Response Response Example
Ligação recebida - Aceita
{
    "packageId": "019c8d5d-086d-7b44-af29-5b5e0bb5a0b1",
    "channelId": "019c8bef-772c-7d44-a65b-3f4bca83a5e0",
    "organizationID": "019c8beb-c216-70a5-9ba4-36742983d073",
    "accountId": "019c8beb-c43a-79dd-af94-ca1b2fda805f",
    "content": {
        "type": "CALL_TERMINATED",
        "reason": "accepted",
        "callTime": "2026-02-24T01:56:50+00:00",
        "timestamp": "2026-02-24T01:56:50.3306391+00:00",
        "from": {
            "type": "WHATSAPP",
            "lid": "5214174228643@lid",
            "number": "5214174228643@lid"
        }
    },
    "timestamp": "2026-02-24T01:56:50.4136196+00:00"
}
Modificado em 2026-04-15 22:24:57
Página anterior
Lista de Histórico
Próxima página
Lista de contatos do grupo
Built with