# VZaps Docs

## Docs

- [Assinar Instancia](https://docs.vzaps.com/api-reference/billing/assinar-instancia.md): Inicia a assinatura da instancia. O fluxo padrao da API e o modo `direct`: cobranca no metodo de pagamento padrao (cartao de credito) do cliente Stripe. Corpo vazio `{}` segue esse caminho. O corpo opcional pode incluir URLs de retorno; veja o schema.
- [Retomar assinatura](https://docs.vzaps.com/api-reference/billing/retomar-assinatura.md): Quando a assinatura estava marcada para encerrar ao fim do periodo, este endpoint reverte esse agendamento e mantem a cobranca ativa.
- [Apagar mensagem](https://docs.vzaps.com/api-reference/chat/apagar-mensagem.md): Apaga para todos uma mensagem enviada anteriormente no WhatsApp. A mensagem alvo precisa ter sido enviada por esta instancia.
- [Baixar audio de mensagem](https://docs.vzaps.com/api-reference/chat/baixar-audio-de-mensagem.md): Descriptografa e retorna um audio recebido. Copie os campos de `event.Message.audioMessage` do payload do webhook, convertendo chaves camelCase para **snake_case**. Valores binarios vao em **base64**.
- [Baixar documento de mensagem](https://docs.vzaps.com/api-reference/chat/baixar-documento-de-mensagem.md): Descriptografa e retorna um documento recebido. Copie os campos de `event.Message.documentMessage` do payload do webhook, convertendo chaves camelCase para **snake_case**. Valores binarios vao em **base64**.
- [Baixar imagem de mensagem](https://docs.vzaps.com/api-reference/chat/baixar-imagem-de-mensagem.md): Descriptografa e retorna uma imagem recebida. Copie os campos de `event.Message.imageMessage` do payload do webhook, convertendo chaves camelCase para **snake_case** (`mediaKey` → `media_key`, `fileEncSha256` → `file_enc_sha256`, etc.). Valores binarios vao em **base64**.
- [Baixar video de mensagem](https://docs.vzaps.com/api-reference/chat/baixar-video-de-mensagem.md): Descriptografa e retorna um video recebido. Copie os campos de `event.Message.videoMessage` do payload do webhook, convertendo chaves camelCase para **snake_case**. Valores binarios vao em **base64**.
- [Editar mensagem de texto](https://docs.vzaps.com/api-reference/chat/editar-mensagem-de-texto.md): Edita uma mensagem de texto enviada anteriormente no WhatsApp. A mensagem alvo precisa ter sido enviada por esta instancia.
- [Enviar audio](https://docs.vzaps.com/api-reference/chat/enviar-audio.md)
- [Enviar botoes interativos](https://docs.vzaps.com/api-reference/chat/enviar-botoes-interativos.md): Enfileira botoes de resposta rapida. Envie `phone`, `message`, `footer` (opcional) e `buttons`: em cada botao, `id` (identificador da escolha) e `text` (rotulo).
- [Enviar contato](https://docs.vzaps.com/api-reference/chat/enviar-contato.md)
- [Enviar documento](https://docs.vzaps.com/api-reference/chat/enviar-documento.md)
- [Enviar GIF](https://docs.vzaps.com/api-reference/chat/enviar-gif.md)
- [Enviar imagem](https://docs.vzaps.com/api-reference/chat/enviar-imagem.md)
- [Enviar indicacao de presenca](https://docs.vzaps.com/api-reference/chat/enviar-indicacao-de-presenca.md)
- [Enviar link com preview](https://docs.vzaps.com/api-reference/chat/enviar-link-com-preview.md)
- [Enviar lista (menu)](https://docs.vzaps.com/api-reference/chat/enviar-lista-menu.md): Enfileira mensagem tipo lista. Envie `phone`, `title`, `description`, `button_text` e `sections`: cada secao tem `title` e `rows`; cada linha tem `id`, `title` e opcionalmente `description`.
- [Enviar localizacao](https://docs.vzaps.com/api-reference/chat/enviar-localizacao.md)
- [Enviar mensagem de texto](https://docs.vzaps.com/api-reference/chat/enviar-mensagem-de-texto.md)
- [Enviar sticker](https://docs.vzaps.com/api-reference/chat/enviar-sticker.md)
- [Enviar video](https://docs.vzaps.com/api-reference/chat/enviar-video.md)
- [Marcar mensagens como lidas](https://docs.vzaps.com/api-reference/chat/marcar-mensagens-como-lidas.md)
- [Reagir à mensagem](https://docs.vzaps.com/api-reference/chat/reagir-à-mensagem.md)
- [Remover reação de mensagem](https://docs.vzaps.com/api-reference/chat/remover-reação-de-mensagem.md)
- [Arquivar chat](https://docs.vzaps.com/api-reference/chats/arquivar-chat.md): Arquiva o chat no WhatsApp. Corpo vazio.
- [Definir expiracao de mensagens do chat](https://docs.vzaps.com/api-reference/chats/definir-expiracao-de-mensagens-do-chat.md): Define a expiracao de mensagens efemeras do chat. Valores aceitos: `24_HOURS`, `7_DAYS`, `90_DAYS`, `OFF`. Pode retornar `501 Not Implemented` enquanto o suporte nao estiver disponivel.
- [Deletar chat](https://docs.vzaps.com/api-reference/chats/deletar-chat.md): Remove o chat no WhatsApp. Corpo opcional com `delete_media`.
- [Desafixar chat](https://docs.vzaps.com/api-reference/chats/desafixar-chat.md): Remove a fixacao do chat. Corpo vazio.
- [Desarquivar chat](https://docs.vzaps.com/api-reference/chats/desarquivar-chat.md): Remove o chat da pasta de arquivados. Corpo vazio.
- [Fixar chat](https://docs.vzaps.com/api-reference/chats/fixar-chat.md): Fixa o chat no topo da lista. Corpo vazio.
- [Limpar chat](https://docs.vzaps.com/api-reference/chats/limpar-chat.md): Limpa o historico do chat no WhatsApp. `delete_media` opcional remove midias associadas.
- [Listar chats da instancia](https://docs.vzaps.com/api-reference/chats/listar-chats-da-instancia.md): Devolve metadados paginados dos chats da instancia, ordenados como no WhatsApp (fixados primeiro, depois por horario da ultima mensagem). Nao inclui conteudo de mensagens.
- [Marcar chat como lido](https://docs.vzaps.com/api-reference/chats/marcar-chat-como-lido.md): Marca o chat como lido e zera a contagem de nao lidas. Corpo vazio.
- [Marcar chat como nao lido](https://docs.vzaps.com/api-reference/chats/marcar-chat-como-nao-lido.md): Marca o chat como nao lido. Corpo vazio.
- [Obter metadados de um chat](https://docs.vzaps.com/api-reference/chats/obter-metadados-de-um-chat.md): Devolve metadados de um chat (contato, grupo ou JID). Nao inclui mensagens.
- [Remover silencio do chat](https://docs.vzaps.com/api-reference/chats/remover-silencio-do-chat.md): Remove o silencio do chat. Corpo vazio.
- [Silenciar chat](https://docs.vzaps.com/api-reference/chats/silenciar-chat.md): Silencia notificacoes do chat. Envie `duration_seconds` opcional para silencio temporario.
- [Agendar importacao Chatwoot](https://docs.vzaps.com/api-reference/chatwoot/agendar-importacao-chatwoot.md): Agenda uma importacao manual de contatos, mensagens ou ambos para a configuracao Chatwoot da instancia.
- [Obter configuracao Chatwoot da instancia](https://docs.vzaps.com/api-reference/chatwoot/obter-configuracao-chatwoot-da-instancia.md): Devolve a configuracao unica do Chatwoot da instancia, incluindo o `webhook_url` que deve ser configurado no inbox API do Chatwoot.
- [Remover configuracao Chatwoot](https://docs.vzaps.com/api-reference/chatwoot/remover-configuracao-chatwoot.md): Remove a configuracao Chatwoot da instancia.
- [Salvar configuracao Chatwoot da instancia](https://docs.vzaps.com/api-reference/chatwoot/salvar-configuracao-chatwoot-da-instancia.md): Cria ou atualiza a configuracao unica do Chatwoot da instancia. Quando `auto_create = true`, a API tenta criar a inbox API no Chatwoot e configurar automaticamente o webhook.
- [Webhook recebido do Chatwoot](https://docs.vzaps.com/api-reference/chatwoot/webhook-recebido-do-chatwoot.md): Endpoint de callback usado pelo Chatwoot para encaminhar eventos da inbox API para a instancia. Este endpoint existe para configuracao da integracao; nao deve ser chamado manualmente pelo integrador final, exceto em testes controlados.
- [Adicionar contato](https://docs.vzaps.com/api-reference/contact/adicionar-contato.md)
- [Listar contatos salvos](https://docs.vzaps.com/api-reference/contact/listar-contatos-salvos.md)
- [Alterar configuracoes do grupo](https://docs.vzaps.com/api-reference/group/alterar-configuracoes-do-grupo.md)
- [Alterar descricao do grupo](https://docs.vzaps.com/api-reference/group/alterar-descricao-do-grupo.md)
- [Alterar foto do grupo](https://docs.vzaps.com/api-reference/group/alterar-foto-do-grupo.md)
- [Alterar nome do grupo](https://docs.vzaps.com/api-reference/group/alterar-nome-do-grupo.md)
- [Consultar grupo](https://docs.vzaps.com/api-reference/group/consultar-grupo.md)
- [Consultar link de convite do grupo](https://docs.vzaps.com/api-reference/group/consultar-link-de-convite-do-grupo.md)
- [Criar grupo](https://docs.vzaps.com/api-reference/group/criar-grupo.md)
- [Listar grupos](https://docs.vzaps.com/api-reference/group/listar-grupos.md)
- [Promover participantes a admin](https://docs.vzaps.com/api-reference/group/promover-participantes-a-admin.md)
- [Remover admin do grupo](https://docs.vzaps.com/api-reference/group/remover-admin-do-grupo.md)
- [Atualizar dados da instancia](https://docs.vzaps.com/api-reference/instancias/atualizar-dados-da-instancia.md): Atualiza dados da instancia. Use o exemplo de corpo JSON abaixo.
- [Cancelar instancia](https://docs.vzaps.com/api-reference/instancias/cancelar-instancia.md): Cancela a instancia pela API principal. O efeito no periodo de cobranca depende do estado atual da assinatura.
- [Criar Instancia](https://docs.vzaps.com/api-reference/instancias/criar-instancia.md): Cria uma instancia, gera o token da instancia e devolve a URL publica da instancia no app. Embora seja um endpoint publico de integracao, ele exige JWT.
- [Listar instancias](https://docs.vzaps.com/api-reference/instancias/listar-instancias.md): Retorna uma listagem paginada das instancias em formato resumido. Envie `Authorization: Bearer <JWT>`. Para usuarios com role `user`, o backend aplica o escopo do proprio usuario no filtro.
- [Consultar fila de mensagens](https://docs.vzaps.com/api-reference/queue/consultar-fila-de-mensagens.md)
- [Consultar fila de operacoes](https://docs.vzaps.com/api-reference/queue/consultar-fila-de-operacoes.md)
- [Limpar fila de mensagens](https://docs.vzaps.com/api-reference/queue/limpar-fila-de-mensagens.md)
- [Limpar fila de operacoes](https://docs.vzaps.com/api-reference/queue/limpar-fila-de-operacoes.md)
- [Remover mensagem da fila](https://docs.vzaps.com/api-reference/queue/remover-mensagem-da-fila.md)
- [Remover operacao da fila](https://docs.vzaps.com/api-reference/queue/remover-operacao-da-fila.md)
- [Consultar conexao com o WhatsApp](https://docs.vzaps.com/api-reference/sessao/consultar-conexao-com-o-whatsapp.md): Indica se a conta WhatsApp da instancia esta autenticada (pareada e ativa) neste momento. O campo `data.connected` e `true` quando ha sessao WhatsApp logada; caso contrario e `false`. O estado do socket interno da sessao nao e exposto.
- [Consultar QR code da sessao](https://docs.vzaps.com/api-reference/sessao/consultar-qr-code-da-sessao.md): Retorna o QR code em data URL quando a sessao ainda nao estiver logada. Se a sessao ja estiver conectada e logada, devolve `Status` e `Phone`. Chamar este endpoint (via proxy catalog como `GET /instances/{id}/session/qr` ou pela URL base da instancia) tambem dispara o pareamento no worker quando nec…
- [Desconectar sessao](https://docs.vzaps.com/api-reference/sessao/desconectar-sessao.md): Encerra a sessao WhatsApp da instancia. Em caso de sucesso, a resposta e `InstanceActionResponse` com `status` em geral `offline` (sessao encerrada ou instancia ja estava desligada); `details` resume o resultado em linguagem simples.
- [Gerar codigo de pareamento por telefone](https://docs.vzaps.com/api-reference/sessao/gerar-codigo-de-pareamento-por-telefone.md)
- [Reiniciar instancia](https://docs.vzaps.com/api-reference/sessao/reiniciar-instancia.md)
- [Atualizar TypeBot](https://docs.vzaps.com/api-reference/typebot/atualizar-typebot.md)
- [Criar TypeBot na instancia](https://docs.vzaps.com/api-reference/typebot/criar-typebot-na-instancia.md): Cria uma configuracao de TypeBot. A instancia pode ter varios TypeBots; o gatilho de maior `priority` que casar com a mensagem recebida assume a sessao.
- [Encerrar sessao TypeBot](https://docs.vzaps.com/api-reference/typebot/encerrar-sessao-typebot.md): Encerra uma sessao do TypeBot. O path param `session` aceita:
- [Excluir TypeBot](https://docs.vzaps.com/api-reference/typebot/excluir-typebot.md)
- [Iniciar sessao TypeBot](https://docs.vzaps.com/api-reference/typebot/iniciar-sessao-typebot.md): Inicia manualmente uma sessao do TypeBot para um contato. Informe o `public_id` do TypeBot cadastrado nesta instancia, o telefone do contato, um `push_name` opcional e a mensagem inicial.
- [Listar sessoes TypeBot](https://docs.vzaps.com/api-reference/typebot/listar-sessoes-typebot.md): Lista todas as sessoes ativas, pausadas ou encerradas da instancia.
- [Listar TypeBots da instancia](https://docs.vzaps.com/api-reference/typebot/listar-typebots-da-instancia.md): Devolve todas as configuracoes de TypeBot da instancia, ordenadas por prioridade descendente.
- [Pausar sessao TypeBot](https://docs.vzaps.com/api-reference/typebot/pausar-sessao-typebot.md): Pausa uma sessao aberta do TypeBot. O path param `session` deve ser o UUID da sessao. A sessao pausada deixa de responder ate ser retomada por um fluxo externo.
- [Consultar avatar de usuario](https://docs.vzaps.com/api-reference/usuarios-avatar-e-contatos/consultar-avatar-de-usuario.md)
- [Consultar detalhes de usuarios](https://docs.vzaps.com/api-reference/usuarios-avatar-e-contatos/consultar-detalhes-de-usuarios.md): Obtem informacoes de perfil na **rede WhatsApp** para JIDs informados (`GetUserInfo`), usando a sessao conectada da instancia.
- [Listar contatos](https://docs.vzaps.com/api-reference/usuarios-avatar-e-contatos/listar-contatos.md)
- [Validar usuarios no WhatsApp](https://docs.vzaps.com/api-reference/usuarios-avatar-e-contatos/validar-usuarios-no-whatsapp.md): Verifica se os numeros estao registrados no WhatsApp e retorna JID/nome verificado quando aplicavel (`IsOnWhatsApp`).
- [Consultar webhook configurado](https://docs.vzaps.com/api-reference/webhook/consultar-webhook-configurado.md): Le a URL do webhook e a lista de eventos inscritos registados na **API principal** (mesma fonte que o aplicativo web).
- [Configurar webhook](https://docs.vzaps.com/pt-BR/api-reference/configure-webhook-post.md): POST /instances/{id}/webhook — grava URL do webhook e eventos inscritos na configuracao da instancia
- [Referencia da API](https://docs.vzaps.com/pt-BR/api-reference/introduction.md): Visao geral dos grupos de endpoints publicos da VZaps
- [Obter Token](https://docs.vzaps.com/pt-BR/api-reference/token.md): Autenticacao server-to-server: envia client_token e client_secret da conta e recebe access_token (JWT).
- [Autenticacao](https://docs.vzaps.com/pt-BR/getting-started/authentication.md): Headers e estrategias de autenticacao para consumir a API publica
- [Fluxo inicial da instancia](https://docs.vzaps.com/pt-BR/getting-started/first-instance-flow.md): Sequencia recomendada para criar, assinar, conectar e operar uma instancia
- [Integracao com o Chatwoot](https://docs.vzaps.com/pt-BR/guides/chatwoot.md): Conecte a instancia WhatsApp ao Chatwoot para atendimento omnichannel bidirecional
- [Integracao com o TypeBot](https://docs.vzaps.com/pt-BR/guides/typebot.md): Configure fluxos automaticos do TypeBot para responder o WhatsApp da instancia
- [Documentacao da API VZaps](https://docs.vzaps.com/pt-BR/index.md): Guia oficial para consumir a API publica da VZaps
- [Primeiros passos](https://docs.vzaps.com/pt-BR/quickstart.md): Fluxo minimo para autenticar, criar uma instancia e comecar a usar a API

## OpenAPI Specs

- [openapi.pt](https://docs.vzaps.com/api-reference/openapi.pt.json)
- [openapi.en](https://docs.vzaps.com/api-reference/openapi.en.json)

## Optional

- [Site](https://vzaps.com)
- [Instagram](https://www.instagram.com/vzaps_api/)
- [Website](https://vzaps.com)
- [Instagram](https://www.instagram.com/vzaps_api/)