# Omni Z-API

## Guias

### Começar

- [Introdução](https://developer.omni.z-api.io/index.md): Documentação oficial do Omni Z-API
- [Autenticação](https://developer.omni.z-api.io/authentication.md): Como gerar e utilizar suas credenciais de API no Omni Z-API

### Canais

- [Visão geral dos canais](https://developer.omni.z-api.io/channels/overview.md): O que cada canal suporta e como conectar cada um
- [Visão geral dos canais](https://developer.omni.z-api.io/channels/overview.md): O que cada canal suporta e como conectar cada um
- [Introdução](https://developer.omni.z-api.io/channels/introduction.md): Crie, conecte e gerencie canais de mensagem no Omni Z-API

### Conectar canais

- [Conectar um canal](https://developer.omni.z-api.io/connect/introduction.md): O mesmo código conecta os cinco canais — o SDK descobre o tipo e cuida do resto
- [Conectar Meta WhatsApp](https://developer.omni.z-api.io/connect/meta-whatsapp.md): Conecte um número à API Oficial pelo Embedded Signup da Meta
- [Conectar WhatsApp Web](https://developer.omni.z-api.io/connect/whatsapp-web.md): Conecte um número escaneando o QR Code, sem passar pela Meta
- [Conectar Instagram](https://developer.omni.z-api.io/connect/instagram.md): Conecte uma conta profissional do Instagram via OAuth
- [Conectar Messenger](https://developer.omni.z-api.io/connect/messenger.md): Conecte uma página do Facebook, com o passo extra de escolha da página
- [Conectar Telegram](https://developer.omni.z-api.io/connect/telegram.md): Conecte um bot do Telegram com o token do BotFather

### Conceitos do WhatsApp

- [Janela de conversa](https://developer.omni.z-api.io/conversation-window.md): Entenda como funciona a janela de conversa de 24 horas do WhatsApp
- [Janela de 24 horas](https://developer.omni.z-api.io/whatsapp-official/24h-window.md): Entenda como funciona a janela de 24 horas da API Oficial do WhatsApp e quando utilizar templates
- [Templates de mensagem](https://developer.omni.z-api.io/whatsapp-official/message-template.md): Entenda o que são os templates da API Oficial do WhatsApp, como funcionam e suas categorias
- [Cobrança](https://developer.omni.z-api.io/whatsapp-official/billing.md): Entenda como funciona o modelo de cobrança da API Oficial do WhatsApp

### Configurar a Meta

- [Introdução](https://developer.omni.z-api.io/whatsapp-official/introduction.md): Principais conceitos da Meta para compreender e utilizar a API Oficial do WhatsApp
- [Pagamento](https://developer.omni.z-api.io/whatsapp-official/payment.md): Configure uma forma de pagamento para enviar templates de mensagem pela API Oficial do WhatsApp
- [Migração de número](https://developer.omni.z-api.io/whatsapp-official/migrate-number.md): Saiba como migrar um número de outro provedor para a API Oficial no Omni Z-API

#### Portfólio

- [Introdução](https://developer.omni.z-api.io/whatsapp-official/portfolio/introduction.md): Gerencie todos os seus ativos de forma centralizada com o Meta Business Manager
- [Como criar um portfólio](https://developer.omni.z-api.io/whatsapp-official/portfolio/how-to-create.md): Aprenda a criar seu Portfólio Empresarial no Meta Business Manager
- [Verificar portfólio](https://developer.omni.z-api.io/whatsapp-official/portfolio/verify-portfolio.md): Aprenda a verificar seu Portfólio Empresarial no Meta Business Manager

#### Conexão

- [Introdução](https://developer.omni.z-api.io/whatsapp-official/connection/introduction.md): Conheça as formas de conectar um número à API Oficial do WhatsApp
- [Cloud API](https://developer.omni.z-api.io/whatsapp-official/connection/cloud-api.md): Conecte um número à API Oficial do WhatsApp por meio da Cloud API
- [Coexistência](https://developer.omni.z-api.io/whatsapp-official/connection/coexistence.md): Conecte um número que já está em uso no WhatsApp Business à API Oficial

## Referência da API

### Canais

- [Criar canal](https://developer.omni.z-api.io/channels/create-channel.md): Crie um novo canal via API
- [Conectar canal Meta WhatsApp](https://developer.omni.z-api.io/channels/connect-channel.md): Fluxo completo para conectar um canal META_WHATSAPP à API Oficial do WhatsApp
- [Origens do SDK](https://developer.omni.z-api.io/channels/sdk-info.md): Libere os domínios que podem chamar o SDK de conexão e diagnostique falhas silenciosas
- [Desconectar canal Meta WhatsApp](https://developer.omni.z-api.io/channels/disconnect.md): Desconecte um canal META_WHATSAPP da API Oficial do WhatsApp
- [Assinar canal](https://developer.omni.z-api.io/channels/subscribe-channel.md): Adicione um canal à assinatura existente após o pagamento ser concluído no painel
- [Cancelar assinatura](https://developer.omni.z-api.io/channels/cancel-subscription.md): Cancele a assinatura de um canal programaticamente
- [Remover canal](https://developer.omni.z-api.io/channels/delete-channel.md): Remova permanentemente um canal via API

### Mensagens

- [Introdução](https://developer.omni.z-api.io/messages/introduction.md): Entenda como funcionam as mensagens livres no Omni Z-API
- [Enviar texto](https://developer.omni.z-api.io/messages/send-text.md): Envie mensagens de texto simples
- [Enviar imagem](https://developer.omni.z-api.io/messages/send-image.md): Envie mensagens com imagem
- [Enviar áudio](https://developer.omni.z-api.io/messages/send-audio.md): Envie mensagens de áudio
- [Enviar vídeo](https://developer.omni.z-api.io/messages/send-video.md): Envie mensagens com vídeo
- [Enviar contato](https://developer.omni.z-api.io/messages/send-contact.md): Envie contatos via WhatsApp
- [Enviar sticker](https://developer.omni.z-api.io/messages/send-sticker.md): Envie stickers (figurinhas) via WhatsApp
- [Enviar localização](https://developer.omni.z-api.io/messages/send-location.md): Envie mensagens de localização
- [Enviar botões de ação](https://developer.omni.z-api.io/messages/send-interactive-action.md): Envie mensagens com botões de ação (URL e ligar)
- [Enviar texto com botões](https://developer.omni.z-api.io/messages/send-interactive-button.md): Envie mensagens de texto com botões de resposta rápida

### Templates (WhatsApp)

- [Introdução](https://developer.omni.z-api.io/templates/introduction.md): Entenda como funcionam os templates de mensagem no Omni Z-API
- [Listar WABAs](https://developer.omni.z-api.io/templates/list-businesses.md): Liste as WABAs disponíveis para o seu token
- [Listar templates](https://developer.omni.z-api.io/templates/list-templates.md): Liste os templates de um WABA
- [Sincronizar templates](https://developer.omni.z-api.io/templates/sync-templates.md): Force a atualização dos status dos templates com a Meta
- [Criar template](https://developer.omni.z-api.io/templates/create-template.md): Crie um novo template e envie para aprovação da Meta
- [Atualizar template](https://developer.omni.z-api.io/templates/update-template.md): Atualize um template existente e reenvie para aprovação
- [Remover template](https://developer.omni.z-api.io/templates/delete-template.md): Remove um template existente
- [Upload de mídia](https://developer.omni.z-api.io/templates/upload-media.md): Obtenha o header_handle para templates com HEADER de imagem, vídeo ou documento
- [Biblioteca de templates](https://developer.omni.z-api.io/templates/template-library.md): Use templates prontos da Meta sem passar por revisão
- [Enviar template](https://developer.omni.z-api.io/messages/send-template.md): Envie templates aprovados pela Meta

### Flows (WhatsApp)

- [Introdução](https://developer.omni.z-api.io/flows/introduction.md): Crie formulários nativos dentro da conversa do WhatsApp com o WhatsApp Flows
- [Listar flows](https://developer.omni.z-api.io/flows/list-flows.md): Liste os flows de um WABA
- [Criar flow](https://developer.omni.z-api.io/flows/create-flow.md): Crie um flow a partir do flow_json
- [Detalhar flow](https://developer.omni.z-api.io/flows/get-flow.md): Busque um flow e suas pendências de validação
- [Atualizar flow](https://developer.omni.z-api.io/flows/update-flow.md): Altere nome, categorias ou o flow_json
- [Publicar flow](https://developer.omni.z-api.io/flows/publish-flow.md): Deixe o flow disponível para uso em mensagens
- [Descontinuar flow](https://developer.omni.z-api.io/flows/deprecate-flow.md): Pare de aceitar novas aberturas do flow
- [Remover flow](https://developer.omni.z-api.io/flows/delete-flow.md): Exclua permanentemente um flow em DRAFT
- [Sincronizar flows](https://developer.omni.z-api.io/flows/sync-flows.md): Force a atualização dos status com a Meta

### Webhooks

- [Introdução](https://developer.omni.z-api.io/webhooks/introduction.md): Receba eventos em tempo real do Omni Z-API no seu sistema via webhooks

#### Canais

- [Webhooks de canal](https://developer.omni.z-api.io/webhooks/channel-webhooks.md): Receba os eventos de um canal específico via webhooks
- [Estrutura dos payloads](https://developer.omni.z-api.io/webhooks/payloads.md): Exemplos reais dos payloads recebidos no seu webhook para cada tipo de mensagem
- [Criar webhook](https://developer.omni.z-api.io/webhooks/create-webhook.md): Registre um endpoint de webhook em um canal
- [Listar webhooks](https://developer.omni.z-api.io/webhooks/list-webhooks.md): Liste todos os webhooks de um canal
- [Detalhar webhook](https://developer.omni.z-api.io/webhooks/get-webhook.md): Busque os dados de um webhook específico
- [Atualizar webhook](https://developer.omni.z-api.io/webhooks/update-webhook.md): Atualize a configuração de um webhook existente
- [Remover webhook](https://developer.omni.z-api.io/webhooks/delete-webhook.md): Remova permanentemente um webhook de um canal

#### Templates

- [Webhooks de template](https://developer.omni.z-api.io/webhooks/template-webhooks.md): Receba os eventos de template do WhatsApp de forma independente de instância
- [Estrutura dos payloads](https://developer.omni.z-api.io/webhooks/template-payloads.md): Exemplos reais dos payloads recebidos no seu webhook para cada evento de template
- [Criar webhook de template](https://developer.omni.z-api.io/webhooks/create-template-webhook.md): Registre um webhook de template (independente de instância)
- [Listar webhooks de template](https://developer.omni.z-api.io/webhooks/list-template-webhooks.md): Liste os webhooks de template do tenant
- [Detalhar webhook de template](https://developer.omni.z-api.io/webhooks/get-template-webhook.md): Busque os dados de um webhook de template específico
- [Atualizar webhook de template](https://developer.omni.z-api.io/webhooks/update-template-webhook.md): Atualize a configuração de um webhook de template existente
- [Remover webhook de template](https://developer.omni.z-api.io/webhooks/delete-template-webhook.md): Remova permanentemente um webhook de template

## Compatibilidade Z-API

### Migração

- [Z-API Compatibilidade](https://developer.omni.z-api.io/z-api/introduction.md): Migre da Z-API para o Omni Z-API sem quebrar suas integrações
- [Autenticação](https://developer.omni.z-api.io/z-api/authentication.md): Como gerar e utilizar suas credenciais de API no Omni Z-API
- [Limitações da API Oficial](https://developer.omni.z-api.io/z-api/limitations.md): Funcionalidades da Z-API que não estão disponíveis na API oficial do WhatsApp

### Mensagens

- [Introdução](https://developer.omni.z-api.io/z-api/messages/introduction.md): Conceitos básicos sobre envio de mensagens na API do Omni Z-API
- [Enviar texto](https://developer.omni.z-api.io/z-api/messages/send-text.md): Envie mensagens de texto simples via WhatsApp
- [Enviar imagem](https://developer.omni.z-api.io/z-api/messages/send-image.md): Envie mensagens com imagens via WhatsApp
- [Enviar áudio](https://developer.omni.z-api.io/z-api/messages/send-audio.md): Envie mensagens de áudio via WhatsApp
- [Enviar vídeo](https://developer.omni.z-api.io/z-api/messages/send-video.md): Envie mensagens com vídeo via WhatsApp
- [Enviar documento](https://developer.omni.z-api.io/z-api/messages/send-document.md): Envie documentos (PDF, DOC, XLS, etc) via WhatsApp
- [Enviar sticker](https://developer.omni.z-api.io/z-api/messages/send-sticker.md): Envie stickers (figurinhas) via WhatsApp
- [Enviar link](https://developer.omni.z-api.io/z-api/messages/send-link.md): Envie mensagens com preview de link via WhatsApp
- [Enviar contato](https://developer.omni.z-api.io/z-api/messages/send-contact.md): Envie contatos via WhatsApp
- [Enviar reação](https://developer.omni.z-api.io/z-api/messages/send-reaction.md): Envie uma reação (emoji) a uma mensagem existente
- [Remover reação](https://developer.omni.z-api.io/z-api/messages/send-remove-reaction.md): Remove uma reação (emoji) de uma mensagem existente
- [Responder mensagem](https://developer.omni.z-api.io/z-api/messages/reply-message.md): Responda mensagens existentes via WhatsApp
- [Enviar botões de ação](https://developer.omni.z-api.io/z-api/messages/send-button-actions.md): Envie mensagens com botões de ação (ligar, URL, resposta rápida)
- [Enviar lista de botões](https://developer.omni.z-api.io/z-api/messages/send-button-list.md): Envie mensagens com botões de seleção rápida
- [Enviar botão Pix](https://developer.omni.z-api.io/z-api/messages/send-button-pix.md): Envie mensagens com botão de pagamento via Pix
- [Enviar carrossel](https://developer.omni.z-api.io/z-api/messages/send-carousel.md): Envie mensagens com carrossel de cards interativos
- [Enviar catálogo](https://developer.omni.z-api.io/z-api/messages/send-catalog.md): Envie o catálogo de produtos do WhatsApp Business
- [Enviar produto](https://developer.omni.z-api.io/z-api/messages/send-product.md): Envie produtos do catálogo do WhatsApp Business

## OpenAPI Specs

- [openapi-create](/pt/channels/openapi-create.json)
- [openapi-connect](/pt/channels/openapi-connect.json)
- [openapi-sdk-info](/pt/channels/openapi-sdk-info.json)
- [openapi-disconnect](/pt/channels/openapi-disconnect.json)
- [openapi-subscribe](/pt/channels/openapi-subscribe.json)
- [openapi-cancel](/pt/channels/openapi-cancel.json)
- [openapi-delete](/pt/channels/openapi-delete.json)
- [openapi](/pt/messages/openapi.json)
- [openapi-image](/pt/messages/openapi-image.json)
- [openapi-audio](/pt/messages/openapi-audio.json)
- [openapi-video](/pt/messages/openapi-video.json)
- [openapi-contact](/pt/messages/openapi-contact.json)
- [openapi-sticker](/pt/messages/openapi-sticker.json)
- [openapi-location](/pt/messages/openapi-location.json)
- [openapi-interactive-action](/pt/messages/openapi-interactive-action.json)
- [openapi-interactive-button](/pt/messages/openapi-interactive-button.json)
- [openapi](/pt/templates/openapi.json)
- [openapi-template](/pt/messages/openapi-template.json)
- [openapi](/pt/flows/openapi.json)
- [openapi](/pt/webhooks/openapi.json)
- [openapi-template](/pt/webhooks/openapi-template.json)
- [openapi-create-channel](/es/channels/openapi-create-channel.json)
- [openapi-create-channel](/pt/channels/openapi-create-channel.json)
- [openapi](/pt/z-api/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (95 pages)](https://developer.omni.z-api.io/_llms/en.md): Documentation for English.
- [Spanish (95 pages)](https://developer.omni.z-api.io/_llms/es.md): Documentation for Spanish.