Copiar Página
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
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
ContatoWhatsapp
Copiar Página
Esta estrutura é utilizada tanto para a origem (from) quanto destino (to) do contato da mensagem.
{
"type"
:
"WHATSAPP"
,
"jid"
:
"string"
,
"lid"
:
"string"
,
"number"
:
"string"
,
"name"
:
"string"
}