# Documentação técnica das API do Messagefy

## Docs
- [Introdução](https://docs.messagefy.io/introdu%C3%A7%C3%A3o-1931836m0.md): 
- [Começando](https://docs.messagefy.io/come%C3%A7ando-1931837m0.md): 
- [Guia de Integração](https://docs.messagefy.io/guia-de-integra%C3%A7%C3%A3o-1931838m0.md): 
- [Collections Postman](https://docs.messagefy.io/collections-postman-1931839m0.md): 
- OnBoarding [OnBoarding para Organizações](https://docs.messagefy.io/onboarding-para-organiza%C3%A7%C3%B5es-1945305m0.md): 
- Me [Introdução](https://docs.messagefy.io/introdu%C3%A7%C3%A3o-1931840m0.md): 
- Contas [Introdução](https://docs.messagefy.io/introdu%C3%A7%C3%A3o-1931842m0.md): 
- API Key [Introdução](https://docs.messagefy.io/introdu%C3%A7%C3%A3o-1931843m0.md): 
- Administrando Canais [Introdução](https://docs.messagefy.io/introdu%C3%A7%C3%A3o-1931844m0.md): 
- Usando o Canal Whatsapp [Introdução](https://docs.messagefy.io/introdu%C3%A7%C3%A3o-1931845m0.md): 
- Recebendo WebHooks [Guia Completo de WebHooks](https://docs.messagefy.io/guia-completo-de-webhooks-1931846m0.md): 

## API Docs
- Me [Sobre](https://docs.messagefy.io/sobre-27092361e0.md): Este EndPoint pode ser utilizado para validação do acesso e verificação das caracteristicas de uma APIKEY.
- Contas [Criar conta](https://docs.messagefy.io/criar-conta-27092367e0.md): 
- Contas [Listar contas](https://docs.messagefy.io/listar-contas-27092368e0.md): ## 📄 Paginação da Listagem
- Contas [Buscar por id](https://docs.messagefy.io/buscar-por-id-27092369e0.md): 
- Contas [Atualizar conta](https://docs.messagefy.io/atualizar-conta-27092370e0.md): 
- Contas [Deletar conta](https://docs.messagefy.io/deletar-conta-27092371e0.md): 
- API Key [Criar apikey](https://docs.messagefy.io/criar-apikey-27092372e0.md): Esse endpoint criar uma apikey para voce enviar mensagens
- API Key [Listar ApiKeys](https://docs.messagefy.io/listar-apikeys-27092373e0.md): ## 📄 Paginação da Listagem
- API Key [Buscar por ID](https://docs.messagefy.io/buscar-por-id-27092374e0.md): 
- API Key [Atualizar apikey](https://docs.messagefy.io/atualizar-apikey-27092375e0.md): 
- API Key [Deletar apiKey](https://docs.messagefy.io/deletar-apikey-27092376e0.md): 
- Administrando Canais > WebHook [Criar canal de Webhook](https://docs.messagefy.io/criar-canal-de-webhook-27092378e0.md): 
- Administrando Canais > Whatsapp [Criar canal de Whatsapp](https://docs.messagefy.io/criar-canal-de-whatsapp-27092379e0.md): 
- Administrando Canais > Whatsapp [Status do Canal Whatsapp](https://docs.messagefy.io/status-do-canal-whatsapp-27092377e0.md): Permite acompanhar e obter feedback sobre o status operacional do canal (instância) do WhatsApp. Uma instância é uma conexão com um número de telefone que possui uma conta do WhatsApp, responsável pelo envio e recebimento de mensagens,
- Administrando Canais > Whatsapp [Solicitar QRCode](https://docs.messagefy.io/solicitar-qrcode-27092386e0.md): Este método solicita um QRCode (imagem do base64). 
- Administrando Canais > Whatsapp [Solicitar Pair Code](https://docs.messagefy.io/solicitar-pair-code-27092387e0.md): Este método solicita um **Pair Code** (código numérico/alfanumérico) para autenticação da conta.
- Administrando Canais > Whatsapp [Solicitar Desconectar o número](https://docs.messagefy.io/solicitar-desconectar-o-n%C3%BAmero-28499309e0.md): Permite solicitar que o número vinculado ao canal seja desconectado.
- Administrando Canais > Outbox [Listar Mensagens no Outbox do Canal](https://docs.messagefy.io/listar-mensagens-no-outbox-do-canal-32377482e0.md): Lista Mensagens Enviadas para o canal de feedback.
- Administrando Canais > Outbox [Obter detalhes da Mensagem no Outbox do Canal](https://docs.messagefy.io/obter-detalhes-da-mensagem-no-outbox-do-canal-32378158e0.md): Lista detalhes de uma Mensagem do canal de feedback.
- Administrando Canais > Outbox [Reenviar Múltiplas Mensagens no Outbox do Canal](https://docs.messagefy.io/reenviar-m%C3%BAltiplas-mensagens-no-outbox-do-canal-32380511e0.md): Reenvia Mensagem
- Administrando Canais > Outbox [Cancelar Mensagem no Outbox do Canal](https://docs.messagefy.io/cancelar-mensagem-no-outbox-do-canal-32380624e0.md): Reenvia Mensagem
- Administrando Canais [Listar canais](https://docs.messagefy.io/listar-canais-27092380e0.md): ## 📄 Paginação da Listagem
- Administrando Canais [Buscar por id](https://docs.messagefy.io/buscar-por-id-27092381e0.md): 
- Administrando Canais [Atualizar canal](https://docs.messagefy.io/atualizar-canal-27092382e0.md): 
- Administrando Canais [Deletar canal](https://docs.messagefy.io/deletar-canal-27092383e0.md): 
- Administrando Canais [Transferir canal](https://docs.messagefy.io/transferir-canal-28295406e0.md): Transfere um canal do tipo `whatsapp-web` (e seu canal de feedback associado) para outra account dentro da mesma organização. Os dispositivos vinculados ao canal são automaticamente atualizados para operar na account destino, preservando a sessão do WhatsApp.
- Usando o Canal Whatsapp > Contatos e Grupos [Solicitar contatos](https://docs.messagefy.io/solicitar-contatos-27092384e0.md): Ao solicitar a lista de contatos, o messagefy envia os dados automaticamente para o seu endpoint via webhook. Consulte a seção `Recebendo webhooks`.
- Usando o Canal Whatsapp > Contatos e Grupos [Solicitar informações do contato](https://docs.messagefy.io/solicitar-informa%C3%A7%C3%B5es-do-contato-27356588e0.md): Solicita os detalhes de um contato através do JID, LID ou mesmo número do celular.
- Usando o Canal Whatsapp > Contatos e Grupos [Solicitar grupos](https://docs.messagefy.io/solicitar-grupos-27092385e0.md): Ao solicitar a lista de grupos, o messagefy envia os dados automaticamente para o seu endpoint via webhook. Consulte a seção `Recebendo webhooks`.
- Usando o Canal Whatsapp > Contatos e Grupos [Solicitar presença de contato (online/offline)](https://docs.messagefy.io/solicitar-presen%C3%A7a-de-contato-onlineoffline-28315398e0.md): Este endpoint permite se inscrever nos eventos de presença (online/offline) de um contato do WhatsApp. Após a inscrição bem-sucedida, eventos CONTACT_PRESENCE serão entregues via WebHook sempre que o contato mudar de status.
- Usando o Canal Whatsapp > Contatos e Grupos [Solicitar Chats](https://docs.messagefy.io/solicitar-chats-32377660e0.md): Ao solicitar a lista de chats, o messagefy envia os dados automaticamente para o seu endpoint via webhook. Consulte a seção `Recebendo webhooks`.
- Usando o Canal Whatsapp > Contatos e Grupos [Solicitar informação do grupo](https://docs.messagefy.io/solicitar-informa%C3%A7%C3%A3o-do-grupo-32604064e0.md): Ao solicitar a informação do grupo, messagefy envia os dados automaticamente para o seu endpoint via webhook. Consulte a seção `Recebendo webhooks`.
- Usando o Canal Whatsapp > Enviando Mensagens [Texto, imagem, audio, video, documentos e sticker](https://docs.messagefy.io/texto-imagem-audio-video-documentos-e-sticker-27881726e0.md): Este endpoint permite enviar mensagens para qualquer número de telefone habilitado para WhatsApp ou para qualquer grupo/canal do WhatsApp usando seu próprio número conectado ao canal Whatsapp do Messagefy.
- Usando o Canal Whatsapp > Enviando Mensagens [Enviar contatos](https://docs.messagefy.io/enviar-contatos-27362382e0.md): Este endpoint permite enviar um contato como mensagem. 
- Usando o Canal Whatsapp > Enviando Mensagens [Enviar lista de contato](https://docs.messagefy.io/enviar-lista-de-contato-27362943e0.md): Este endpoint permite enviar uma lista de contato como mensagem. 
- Usando o Canal Whatsapp > Enviando Mensagens [Marcar mensagens como lida](https://docs.messagefy.io/marcar-mensagens-como-lida-32393352e0.md): Este endpoint permite marcar uma ou mais mensagens como lidas em um chat do WhatsApp.
- Usando o Canal Whatsapp > Excluindo e Editando Mensagens [Apagar mensagem para todos](https://docs.messagefy.io/apagar-mensagem-para-todos-27092394e0.md): 
- Usando o Canal Whatsapp > Excluindo e Editando Mensagens [Editar mensagem](https://docs.messagefy.io/editar-mensagem-27092395e0.md): 
- Usando o Canal Whatsapp [Recuperar Messagens Antigas](https://docs.messagefy.io/recuperar-messagens-antigas-27600948e0.md): Permitir que aplicações cliente recuperem mensagens históricas de um chat específico, utilizando um `messageId` opcional como ponto de referência para buscar mensagens anteriores ou posteriores.
- Recebendo WebHooks > Mensagens Recebidas [TEXT](https://docs.messagefy.io/text-27092407e0.md): Mensagem do tipo ```TEXT``` recebida no Whatsapp do cliente
- Recebendo WebHooks > Mensagens Recebidas [CONTACT_MESSAGE](https://docs.messagefy.io/contact-message-27363026e0.md): Recebendo contato como mensagem
- Recebendo WebHooks > Mensagens Recebidas [CONTACTS_MESSAGE](https://docs.messagefy.io/contacts-message-27363222e0.md): Recebendo lista de contatos como mensagem
- Recebendo WebHooks [Status do canal](https://docs.messagefy.io/status-do-canal-27092396e0.md): 
- Recebendo WebHooks [QRCode gerado retorno](https://docs.messagefy.io/qrcode-gerado-retorno-27092397e0.md): 
- Recebendo WebHooks [Lista de contatos](https://docs.messagefy.io/lista-de-contatos-27092398e0.md): Será devolvido a lista completa de todos os contatos do canal
- Recebendo WebHooks [Lista de grupos](https://docs.messagefy.io/lista-de-grupos-27092399e0.md): Será devolvido a lista completa de todos os grupos do canal
- Recebendo WebHooks [Mensagem entregue](https://docs.messagefy.io/mensagem-entregue-27092400e0.md): Retorno quando uma mensagem e entregue ao destinatário.
- Recebendo WebHooks [Mensagem lida](https://docs.messagefy.io/mensagem-lida-27092401e0.md): Retorno quando uma mensagem e lida pelo destinatário
- Recebendo WebHooks [Download Disponivel](https://docs.messagefy.io/download-disponivel-27215913e0.md): ## Descricao
- Recebendo WebHooks [Localização e Localização em tempo real](https://docs.messagefy.io/localiza%C3%A7%C3%A3o-e-localiza%C3%A7%C3%A3o-em-tempo-real-27221123e0.md): A informação de localização será retornada. 
- Recebendo WebHooks [Lista de Histórico](https://docs.messagefy.io/lista-de-hist%C3%B3rico-27594739e0.md): Ao se conectar você pode receber uma lista de históricos de mensagens dos chats
- Recebendo WebHooks [Ligação recebida e realizada](https://docs.messagefy.io/liga%C3%A7%C3%A3o-recebida-e-realizada-28497567e0.md): A informação referente às ligações, sejam recebidas ou realizadas, será retornada na estrutura.
- Recebendo WebHooks [Lista de contatos do grupo](https://docs.messagefy.io/lista-de-contatos-do-grupo-31805237e0.md): Será devolvido a lista de contatos do grupo.
- Recebendo WebHooks [Lista de chats](https://docs.messagefy.io/lista-de-chats-32378345e0.md): Será devolvido a lista de chats paginada
- Recebendo WebHooks [Alteração de Grupo](https://docs.messagefy.io/altera%C3%A7%C3%A3o-de-grupo-32613702e0.md): Informações sobre alterações no grupo

## Schemas
- Eventos de WebHook > Eventos de Conexão [PAIR_CODE_GENERATED_RESPONSE: PairCode de conexão](https://docs.messagefy.io/pair-code-generated-response-paircode-de-conex%C3%A3o-12719479d0.md): 
- Eventos de WebHook > Eventos de Conexão [INSTANCE_USER_CONNECT_TIMEOUT: Usuário não realizou Login](https://docs.messagefy.io/instance-user-connect-timeout-usu%C3%A1rio-n%C3%A3o-realizou-login-12719481d0.md): 
- Eventos de WebHook > Eventos de Conexão [DISCONNECTED: Celular desconectado](https://docs.messagefy.io/disconnected-celular-desconectado-12719463d0.md): 
- Eventos de WebHook > Eventos de Conexão [CONNECTED: Celular conectado](https://docs.messagefy.io/connected-celular-conectado-12720036d0.md): 
- Eventos de WebHook > Eventos de Mensagens [EchoMessage: Eco de Mensagem enviada](https://docs.messagefy.io/echomessage-eco-de-mensagem-enviada-12720710d0.md): 
- Eventos de WebHook > Eventos de Status de Mensagens [MESSAGE_SENT: Mensagem enviada](https://docs.messagefy.io/message-sent-mensagem-enviada-12719257d0.md): 
- Eventos de WebHook > Eventos de Status de Mensagens [MESSAGE_DELIVERED: Mensagem entregue](https://docs.messagefy.io/message-delivered-mensagem-entregue-12718802d0.md): 
- Eventos de WebHook > Eventos de Status de Mensagens [MESSAGE_READ: Mensagem lida](https://docs.messagefy.io/message-read-mensagem-lida-12719051d0.md): 
- [ContatoWhatsapp](https://docs.messagefy.io/contatowhatsapp-12600453d0.md): 
- [ContactResponseInfo](https://docs.messagefy.io/contactresponseinfo-12805069d0.md): 
- [AccountResponse](https://docs.messagefy.io/accountresponse-12827772d0.md): 
- [Organization](https://docs.messagefy.io/organization-12827873d0.md): 
- [ResourcePlanResponse](https://docs.messagefy.io/resourceplanresponse-12827874d0.md): 
- [ChannelType](https://docs.messagefy.io/channeltype-12827955d0.md): 
- [ChannelStatus](https://docs.messagefy.io/channelstatus-12827958d0.md): 
- [Provider](https://docs.messagefy.io/provider-12827959d0.md):