1. Administrando Canais
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
      POST
    • Listar ApiKeys
      GET
    • Buscar por ID
      GET
    • Atualizar apikey
      PUT
    • Deletar apiKey
      DELETE
  • 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
      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. Administrando Canais

Introdução

Os canais são o coração da comunicação na plataforma Messagefy. Um "Canal" representa a ponte entre a sua aplicação e um serviço de mensagens, como o WhatsApp, ou um sistema de notificação, como um Webhook.
É através de um canal que você enviará e receberá mensagens. Antes de qualquer comunicação, você deve configurar pelo menos um canal. Atualmente, suportamos dois tipos principais:
Canal de WhatsApp: Permite conectar um número de WhatsApp para enviar e receber mensagens diretamente pela nossa API.
Canal de Webhook: Utilizado para receber notificações em tempo real sobre eventos, como o recebimento de novas mensagens ou atualizações de status de envio.
Nesta seção, você encontrará os endpoints para gerenciar seus canais, permitindo:
Criação: Configurar novos canais de WhatsApp ou Webhook.
Listagem e Busca: Consultar os canais existentes.
Atualização e Deleção: Manter suas configurações de canal sempre atualizadas.
Uma configuração correta dos canais é essencial para garantir que suas mensagens sejam enviadas e recebidas com sucesso.

Mas afinal o que é um canal?#

Tecnicamente falando um canal nada mais é do que uma um container dentro da nossa infraestrutura de servidores, dedicada a prover um ambiente para conexão do seu número.
Cada canal só possui um número, caso precise conectar mais números será necessário criar mais canais.
Para ajudar você a entender o funcionamento do messageFy, nosso serviço se comunica com WhatsApp, e abstraímos os métodos permitindo que você manipule via API.
Para melhor tangibilizar, nos próximos tópicos vamos de forma ordenada te ajudar nos primeiros passos.

Modificado em 2026-01-22 21:53:15
Página anterior
Deletar apiKey
Próxima página
Criar canal de Webhook
Built with