# EZ API

## Docs

- [Autenticação](https://docs.ezapi.com.br/api-reference/authentication.md): Como usar Client-Token, instanceToken e o playground da Mintlify.
- [Listar catálogo por número](https://docs.ezapi.com.br/api-reference/business/catalog-by-phone.md): Lista os produtos do catálogo de uma conta Business específica.
- [Criar produto](https://docs.ezapi.com.br/api-reference/business/create-product.md): Cria um produto no catálogo Business conectado à instância.
- [Excluir produto](https://docs.ezapi.com.br/api-reference/business/delete-product.md): Remove um produto do catálogo Business.
- [Listar catálogo da instância](https://docs.ezapi.com.br/api-reference/business/my-catalog.md): Lista os produtos do catálogo da própria conta Business conectada.
- [Detalhes do produto](https://docs.ezapi.com.br/api-reference/business/product-details.md): Busca um produto específico pelo seu identificador.
- [Expiração das conversas](https://docs.ezapi.com.br/api-reference/chats/expiration.md): Configura a duração das mensagens temporárias em uma conversa específica.
- [Metadados da conversa](https://docs.ezapi.com.br/api-reference/chats/get.md): Retorna metadados da conversa ou grupo informado.
- [Listar conversas](https://docs.ezapi.com.br/api-reference/chats/list.md): Lista conversas e grupos conhecidos pela instância.
- [Alterar estado da conversa](https://docs.ezapi.com.br/api-reference/chats/modify.md): Arquiva, fixa, silencia, marca como lida, limpa ou deleta a conversa.
- [Bloquear ou desbloquear contato](https://docs.ezapi.com.br/api-reference/contacts/block.md): Bloqueia ou desbloqueia um contato específico.
- [Metadados do contato](https://docs.ezapi.com.br/api-reference/contacts/get.md): Retorna metadados de um contato específico.
- [Listar contatos](https://docs.ezapi.com.br/api-reference/contacts/list.md): Lista os contatos conhecidos pela instância com paginação.
- [Número tem WhatsApp?](https://docs.ezapi.com.br/api-reference/contacts/phone-exists.md): Verifica se um número existe no WhatsApp.
- [Validar números em lote](https://docs.ezapi.com.br/api-reference/contacts/phone-exists-batch.md): Valida vários números em lote em uma única requisição.
- [Foto do contato](https://docs.ezapi.com.br/api-reference/contacts/profile-picture.md): Retorna a URL da foto de perfil do contato informado.
- [Erros e respostas](https://docs.ezapi.com.br/api-reference/errors.md): Códigos HTTP, respostas assíncronas e formatos de erro mais comuns da EZ API.
- [Exemplos práticos](https://docs.ezapi.com.br/api-reference/examples.md): Fluxos reais para integração com a EZ API.
- [Aceitar convite do grupo](https://docs.ezapi.com.br/api-reference/groups/accept-invite.md): Aceita um convite de grupo a partir da URL compartilhada.
- [Promover administrador](https://docs.ezapi.com.br/api-reference/groups/add-admin.md): Promove participantes a administradores do grupo.
- [Adicionar participantes](https://docs.ezapi.com.br/api-reference/groups/add-participant.md): Adiciona participantes ao grupo informado.
- [Aprovar participantes](https://docs.ezapi.com.br/api-reference/groups/approve-participant.md): Aprova participantes pendentes no grupo informado.
- [Criar grupo](https://docs.ezapi.com.br/api-reference/groups/create.md): Cria um novo grupo no WhatsApp com os participantes informados.
- [Metadados por link de convite](https://docs.ezapi.com.br/api-reference/groups/invitation-metadata.md): Consulta os metadados do grupo a partir de um link de convite.
- [Sair do grupo](https://docs.ezapi.com.br/api-reference/groups/leave.md): Faz a instância sair do grupo informado.
- [Metadados do grupo](https://docs.ezapi.com.br/api-reference/groups/metadata.md): Retorna nome, descrição, participantes e outras informações do grupo.
- [Visão geral de grupos](https://docs.ezapi.com.br/api-reference/groups/overview.md): Crie grupos, gerencie participantes, convites, foto, descrição e permissões.
- [Remover administrador](https://docs.ezapi.com.br/api-reference/groups/remove-admin.md): Remove privilégios de administrador de participantes do grupo.
- [Remover participantes](https://docs.ezapi.com.br/api-reference/groups/remove-participant.md): Remove participantes do grupo informado.
- [Redefinir link de convite](https://docs.ezapi.com.br/api-reference/groups/reset-invite-link.md): Revoga o link atual de convite e gera um novo link para o grupo.
- [Atualizar descrição do grupo](https://docs.ezapi.com.br/api-reference/groups/update-description.md): Atualiza a descrição do grupo.
- [Atualizar nome do grupo](https://docs.ezapi.com.br/api-reference/groups/update-name.md): Atualiza o assunto do grupo.
- [Atualizar foto do grupo](https://docs.ezapi.com.br/api-reference/groups/update-photo.md): Atualiza a foto do grupo usando uma URL pública da imagem.
- [Atualizar configurações do grupo](https://docs.ezapi.com.br/api-reference/groups/update-settings.md): Configura permissões como mensagens apenas para admins e aprovação de participantes.
- [Métricas do AntiBan](https://docs.ezapi.com.br/api-reference/instance/antiban-metrics.md): Consulta o estado e as métricas de runtime relacionadas ao AntiBan.
- [Atualizar leitura automática](https://docs.ezapi.com.br/api-reference/instance/auto-read-message.md): Ativa ou desativa a leitura automática das mensagens recebidas.
- [Atualizar rejeição automática de chamadas](https://docs.ezapi.com.br/api-reference/instance/call-reject-auto.md): Ativa ou desativa a rejeição automática de chamadas recebidas.
- [Atualizar mensagem de rejeição de chamadas](https://docs.ezapi.com.br/api-reference/instance/call-reject-message.md): Define a mensagem enviada automaticamente quando uma chamada é rejeitada.
- [Criar instância](https://docs.ezapi.com.br/api-reference/instance/create.md): Cria uma nova instância da EZ API e retorna os identificadores necessários para as próximas chamadas.
- [Excluir instância](https://docs.ezapi.com.br/api-reference/instance/delete.md): Remove permanentemente a instância e os dados operacionais associados.
- [Dados do dispositivo](https://docs.ezapi.com.br/api-reference/instance/device.md): Retorna informações do dispositivo atualmente conectado à instância.
- [Desconectar instância](https://docs.ezapi.com.br/api-reference/instance/disconnect.md): Desconecta a sessão atual e limpa o estado de autenticação para exigir novo pareamento.
- [Dados da instância](https://docs.ezapi.com.br/api-reference/instance/me.md): Retorna metadados da instância, webhooks configurados e ajustes operacionais.
- [Visão geral de instâncias](https://docs.ezapi.com.br/api-reference/instance/overview.md): Crie, conecte, monitore e ajuste o comportamento da sua instância do WhatsApp.
- [Gerar código de pareamento](https://docs.ezapi.com.br/api-reference/instance/phone-code.md): Solicita um código de pareamento para conectar a instância sem escanear QR Code.
- [Atualizar descrição do perfil](https://docs.ezapi.com.br/api-reference/instance/profile-description.md): Atualiza a descrição ou recado do perfil do WhatsApp.
- [Atualizar nome do perfil](https://docs.ezapi.com.br/api-reference/instance/profile-name.md): Atualiza o nome exibido no perfil do WhatsApp conectado.
- [Atualizar foto do perfil](https://docs.ezapi.com.br/api-reference/instance/profile-picture.md): Atualiza a foto do perfil do WhatsApp usando uma URL pública da imagem.
- [Obter QR Code](https://docs.ezapi.com.br/api-reference/instance/qr-code.md): Retorna o QR Code atual da instância em formato textual para conexão.
- [Obter QR Code em PNG](https://docs.ezapi.com.br/api-reference/instance/qr-code-image.md): Retorna o QR Code atual em imagem PNG para exibir em navegador, app ou dashboard.
- [Reiniciar instância](https://docs.ezapi.com.br/api-reference/instance/restart.md): Reinicia a sessão e força uma nova tentativa de conexão da instância.
- [Status da instância](https://docs.ezapi.com.br/api-reference/instance/status.md): Consulta o estado atual da conexão da instância com o WhatsApp.
- [Atualizar AntiBan](https://docs.ezapi.com.br/api-reference/instance/update-antiban.md): Ativa ou desativa a estratégia AntiBan para a instância.
- [Renomear instância](https://docs.ezapi.com.br/api-reference/instance/update-name.md): Atualiza o nome interno usado para identificar a instância.
- [Introdução à API](https://docs.ezapi.com.br/api-reference/introduction.md): Base URL, autenticação, estrutura das rotas e como a documentação foi organizada.
- [Excluir mensagem](https://docs.ezapi.com.br/api-reference/messages/delete-message.md): Solicita a exclusão de uma mensagem existente no chat informado.
- [Reencaminhar mensagem](https://docs.ezapi.com.br/api-reference/messages/forward-message.md): Reencaminha uma mensagem já existente para outro contato ou grupo.
- [Mensagens em grupo](https://docs.ezapi.com.br/api-reference/messages/group-messaging.md): Envie mensagens de texto, mídia e interativos para grupos do WhatsApp.
- [Visão geral de mensagens](https://docs.ezapi.com.br/api-reference/messages/overview.md): Envie mensagens assíncronas em texto, mídia, interativos e recursos avançados.
- [Marcar mensagem como lida](https://docs.ezapi.com.br/api-reference/messages/read-message.md): Envia o recibo de leitura para a mensagem informada.
- [Enviar áudio](https://docs.ezapi.com.br/api-reference/messages/send-audio.md): Envia um áudio ou nota de voz a partir de uma URL pública.
- [Enviar botões de ação](https://docs.ezapi.com.br/api-reference/messages/send-button-actions.md): Envia botões com ações do tipo resposta, chamada ou URL.
- [Enviar mensagem com botões](https://docs.ezapi.com.br/api-reference/messages/send-button-list.md): Envia botões rápidos com cabeçalho de texto, imagem ou vídeo.
- [Enviar botão OTP](https://docs.ezapi.com.br/api-reference/messages/send-button-otp.md): Envia um botão de confirmação com código OTP.
- [Enviar botão PIX](https://docs.ezapi.com.br/api-reference/messages/send-button-pix.md): Envia um botão interativo de pagamento PIX.
- [Enviar contato](https://docs.ezapi.com.br/api-reference/messages/send-contact.md): Envia um único contato em formato compatível com WhatsApp.
- [Enviar vários contatos](https://docs.ezapi.com.br/api-reference/messages/send-contacts.md): Envia uma lista de contatos em uma única mensagem.
- [Enviar documento](https://docs.ezapi.com.br/api-reference/messages/send-document.md): Envia um documento usando a extensão do arquivo como parte da rota.
- [Erros de envio](https://docs.ezapi.com.br/api-reference/messages/send-errors.md): Lista erros recentes de envio registrados pelo worker da instância.
- [Enviar GIF](https://docs.ezapi.com.br/api-reference/messages/send-gif.md): Envia um GIF por URL para um contato ou grupo.
- [Enviar imagem](https://docs.ezapi.com.br/api-reference/messages/send-image.md): Envia uma imagem por URL com legenda opcional.
- [Enviar link](https://docs.ezapi.com.br/api-reference/messages/send-link.md): Envia um link com texto complementar e prévia quando disponível.
- [Enviar localização](https://docs.ezapi.com.br/api-reference/messages/send-location.md): Envia uma localização com latitude, longitude e nome opcional.
- [Enviar lista de opções](https://docs.ezapi.com.br/api-reference/messages/send-option-list.md): Envia uma lista interativa com seções e opções selecionáveis.
- [Enviar enquete](https://docs.ezapi.com.br/api-reference/messages/send-poll.md): Envia uma enquete com múltiplas opções para um contato ou grupo.
- [Enviar PTV](https://docs.ezapi.com.br/api-reference/messages/send-ptv.md): Envia um vídeo circular no formato PTV (push-to-view).
- [Enviar reação](https://docs.ezapi.com.br/api-reference/messages/send-reaction.md): Adiciona uma reação a uma mensagem existente.
- [Remover reação](https://docs.ezapi.com.br/api-reference/messages/send-remove-reaction.md): Remove a reação aplicada anteriormente a uma mensagem.
- [Enviar sticker](https://docs.ezapi.com.br/api-reference/messages/send-sticker.md): Envia um sticker para um contato ou grupo.
- [Enviar texto](https://docs.ezapi.com.br/api-reference/messages/send-text.md): Envia texto simples, respostas a mensagens anteriores ou menções em grupos.
- [Enviar vídeo](https://docs.ezapi.com.br/api-reference/messages/send-video.md): Envia um vídeo por URL com legenda opcional.
- [Visualização do recado](https://docs.ezapi.com.br/api-reference/privacy/description.md): Atualiza quem pode ver o recado ou descrição do perfil.
- [Permissão para grupos](https://docs.ezapi.com.br/api-reference/privacy/group-add.md): Define quem pode adicionar o número em grupos.
- [Visto por último](https://docs.ezapi.com.br/api-reference/privacy/last-seen.md): Atualiza a visibilidade do visto por último.
- [Duração das mensagens](https://docs.ezapi.com.br/api-reference/privacy/messages-duration.md): Configura a duração padrão das mensagens temporárias em novas conversas.
- [Visualização de online](https://docs.ezapi.com.br/api-reference/privacy/online.md): Atualiza quem pode visualizar o status online.
- [Visualização da foto do perfil](https://docs.ezapi.com.br/api-reference/privacy/photo.md): Atualiza quem pode ver a foto do perfil.
- [Confirmações de leitura](https://docs.ezapi.com.br/api-reference/privacy/read-receipts.md): Ativa ou desativa as confirmações de leitura nas conversas individuais.
- [Limpar fila](https://docs.ezapi.com.br/api-reference/queue/clear.md): Remove todas as mensagens pendentes da fila de envio da instância.
- [Consultar fila](https://docs.ezapi.com.br/api-reference/queue/get.md): Retorna metadados e contagem atual da fila de envio da instância.
- [Publicar imagem no status](https://docs.ezapi.com.br/api-reference/status/send-image.md): Publica uma imagem com legenda opcional no status do WhatsApp.
- [Publicar texto no status](https://docs.ezapi.com.br/api-reference/status/send-text.md): Publica um texto no status do WhatsApp da instância.
- [Webhook de presença no chat](https://docs.ezapi.com.br/api-reference/webhooks/chat-presence.md): Configura a URL chamada quando o status de presença do chat muda.
- [Webhook ao conectar](https://docs.ezapi.com.br/api-reference/webhooks/connected.md): Configura a URL chamada quando a instância se conecta ao WhatsApp.
- [Webhook ao enviar](https://docs.ezapi.com.br/api-reference/webhooks/delivery.md): Configura a URL chamada quando uma mensagem é aceita ou falha no envio.
- [Webhook ao desconectar](https://docs.ezapi.com.br/api-reference/webhooks/disconnected.md): Configura a URL chamada quando a instância é desconectada.
- [Webhook de status de mensagens](https://docs.ezapi.com.br/api-reference/webhooks/message-status.md): Configura a URL chamada quando o status de uma mensagem muda.
- [Visão geral de webhooks](https://docs.ezapi.com.br/api-reference/webhooks/overview.md): Configure URLs HTTPS para receber eventos em tempo real da EZ API.
- [Payloads de webhooks](https://docs.ezapi.com.br/api-reference/webhooks/payloads.md): Exemplos reais dos payloads entregues pelos webhooks da EZ API.
- [Webhook ao receber](https://docs.ezapi.com.br/api-reference/webhooks/received.md): Configura a URL chamada quando a instância recebe uma nova mensagem.
- [Webhook ao receber e enviadas por mim](https://docs.ezapi.com.br/api-reference/webhooks/received-delivery.md): Configura a URL do webhook de recebimento incluindo mensagens enviadas pela própria instância.
- [EZ API](https://docs.ezapi.com.br/index.md): API de automação WhatsApp com instâncias, mensagens, grupos, webhooks e catálogo Business.
- [Guia rápido](https://docs.ezapi.com.br/quickstart.md): Crie uma instância, conecte ao WhatsApp e envie a primeira mensagem com a EZ API.

## OpenAPI Specs

- [openapi](https://docs.ezapi.com.br/api-reference/openapi.json)