# D-API

- [WhatsApp (não oficial)](https://docs.d-api.cloud/whatsapp/introducao.md): Conexão via QR code ou pareamento, organizada por sessão.
- [API Oficial para SaaS (provedor)](https://docs.d-api.cloud/whatsapp/api-oficial-saas.md): Ofereça a conexão do WhatsApp API Oficial dentro do seu próprio SaaS, usando a D-API como provedor.
- [Assistente de Integração](https://docs.d-api.cloud/whatsapp/instalar-assistente.md): Instale a extensão do Chrome e migre uma conexão do WhatsApp Web já ativa, sem escanear QR.
- [Ligações por Stream](https://docs.d-api.cloud/whatsapp/ligacoes/stream.md): Faça e receba o áudio de chamadas de voz do WhatsApp em tempo real no seu app, por WebSocket.
- [Receber Ligações](https://docs.d-api.cloud/whatsapp/ligacoes/receber.md): Assine as chamadas de WhatsApp recebidas em tempo real, atenda pelo gateway e fale pelo WebSocket de mídia.
- [Comandos assíncronos](https://docs.d-api.cloud/whatsapp/comandos-assincronos.md): Envie comandos com async: true, receba o resultado pelo webhook command.result ou consulte pelo commandId.
- [Visão geral dos webhooks](https://docs.d-api.cloud/whatsapp/webhooks/visao-geral.md): Como configurar, receber e processar os eventos de uma sessão WhatsApp.
- [Evento messages.received](https://docs.d-api.cloud/whatsapp/webhooks/messages-received.md): Disparado quando uma mensagem é recebida.
- [Evento messages.sent](https://docs.d-api.cloud/whatsapp/webhooks/messages-sent.md): Disparado quando uma mensagem é enviada via API da D-API.
- [Status de mensagens](https://docs.d-api.cloud/whatsapp/webhooks/status-de-mensagens.md): Eventos de leitura, entrega e exclusão de mensagens.
- [Eventos de conexão](https://docs.d-api.cloud/whatsapp/webhooks/conexao.md): QR code, código de pareamento e mudanças de status da sessão.
- [Chats, contatos e presença](https://docs.d-api.cloud/whatsapp/webhooks/chats-contatos-presenca.md): Atualizações de chats, contatos e presença (online/digitando).
- [Eventos de grupos](https://docs.d-api.cloud/whatsapp/webhooks/grupos.md): Entradas, saídas, promoções e solicitações de entrada em grupos.
- [Eventos de etiquetas](https://docs.d-api.cloud/whatsapp/webhooks/etiquetas.md): Etiquetas (Listas do WhatsApp) criadas, editadas e aplicadas a conversas e mensagens.
- [Eventos de chamadas de voz (VoIP)](https://docs.d-api.cloud/whatsapp/webhooks/chamadas.md): Chamadas de voz do WhatsApp recebidas e realizadas no número da sessão.
- [Histórico e sincronização](https://docs.d-api.cloud/whatsapp/webhooks/historico-e-sincronizacao.md): Eventos do backfill de histórico e da sincronização do AppState, e o que é (ou não) entregue no webhook.
- [Visão geral dos webhooks](https://docs.d-api.cloud/sms/webhooks/visao-geral.md): Como o D-API notifica seu sistema sobre o status de entrega dos SMS.
- [Eventos](https://docs.d-api.cloud/sms/webhooks/eventos.md): Eventos de status de entrega de SMS e códigos de erro normalizados.
- [Visão geral dos webhooks](https://docs.d-api.cloud/ura/webhooks/visao-geral.md): Como o D-API notifica seu sistema sobre o ciclo de vida das ligações URA (voz).
- [Eventos](https://docs.d-api.cloud/ura/webhooks/eventos.md): Eventos do ciclo de vida da ligação URA e tabela de códigos de cause.
- [Introdução](https://docs.d-api.cloud/api-reference/introduction.md): Base URL, autenticação, erros e limites da API REST da D-API.
- [Quickstart](https://docs.d-api.cloud/api-reference/quickstart.md): Crie uma sessão, conecte o WhatsApp e envie a primeira mensagem.
- [Criar uma sessão](https://docs.d-api.cloud/api-reference/endpoints/criar-sessao.md): Crie ou inicie uma sessão do WhatsApp.
- [Conectar via QR code](https://docs.d-api.cloud/api-reference/endpoints/conectar-qr.md): Obtenha o QR code para conectar a sessão ao WhatsApp.
- [Gerar código de migração (OTP)](https://docs.d-api.cloud/api-reference/endpoints/gerar-otp.md): Gere um código de uso único para migrar uma sessão do WhatsApp Web.
- [Enviar mensagem de texto](https://docs.d-api.cloud/api-reference/endpoints/enviar-texto.md): Envie uma mensagem de texto simples via WhatsApp.
- [Enviar imagem](https://docs.d-api.cloud/api-reference/endpoints/enviar-imagem.md): Envie uma mensagem com imagem e legenda.
- [Enviar mensagem de lista](https://docs.d-api.cloud/api-reference/endpoints/enviar-lista.md): Envie uma mensagem interativa com lista de opções.
- [Criar grupo](https://docs.d-api.cloud/api-reference/endpoints/criar-grupo.md): Crie um grupo do WhatsApp com participantes e configurações.
- [Baixar mídia](https://docs.d-api.cloud/api-reference/endpoints/baixar-midia.md): Baixe mídia recebida de forma unificada.
- [Consultar comando assíncrono](https://docs.d-api.cloud/api-reference/endpoints/consultar-comando.md): Acompanhe o resultado de um comando enviado com async.
- [Envio assíncrono em ordem (sequential)](https://docs.d-api.cloud/api-reference/endpoints/envio-sequencial.md): Garanta que mensagens assíncronas para o mesmo contato cheguem na ordem em que foram enviadas.
- [Criar conexão manualmente](https://docs.d-api.cloud/api-reference/cloud-api/criar-conexao-manual.md): Conecte um número da API Oficial (Cloud API) informando WABA, número e token da Meta.
- [Obter conexão](https://docs.d-api.cloud/api-reference/cloud-api/obter-conexao.md): Consulte os detalhes de uma conexão da API Oficial (Cloud API) pelo id.
- [Atualizar conexão](https://docs.d-api.cloud/api-reference/cloud-api/atualizar-conexao.md): Atualize o roteamento de webhook ou rotacione o token de acesso da Meta.
- [Obter access token da Meta](https://docs.d-api.cloud/api-reference/cloud-api/obter-access-token.md): Recupere, já descriptografado, o access token da Meta guardado numa conexão da API Oficial — e descubra de que tipo ele é.
- [Listar templates aprovados](https://docs.d-api.cloud/api-reference/cloud-api/listar-templates.md): Liste os templates de mensagem APROVADOS da WABA da conexão.
- [Listar todos os templates](https://docs.d-api.cloud/api-reference/cloud-api/listar-templates-todos.md): Liste TODOS os templates da WABA, em qualquer status de revisão.
- [Criar template](https://docs.d-api.cloud/api-reference/cloud-api/criar-template.md): Envie um novo template de mensagem para revisão da Meta.
- [Excluir template](https://docs.d-api.cloud/api-reference/cloud-api/excluir-template.md): Exclua um template da WABA pelo nome (todas as línguas).
- [Enviar template](https://docs.d-api.cloud/api-reference/cloud-api/enviar-template.md): Envie um template aprovado por uma conexão da API Oficial (Cloud API).
- [Retorna informações básicas sobre a API](https://docs.d-api.cloud/api-reference/início/retorna-informações-básicas-sobre-a-api.md)
- [Retorna o status de saúde da API incluindo DB, RabbitMQ e Redis](https://docs.d-api.cloud/api-reference/início/retorna-o-status-de-saúde-da-api-incluindo-db-rabbitmq-e-redis.md)
- [Enviar mensagem de texto](https://docs.d-api.cloud/api-reference/mensagens/enviar-mensagem-de-texto.md): Envia uma mensagem de texto simples via WhatsApp
- [Enviar mensagem com imagem](https://docs.d-api.cloud/api-reference/mensagens/enviar-mensagem-com-imagem.md): Envia uma imagem com legenda opcional via WhatsApp
- [Enviar mensagem com vídeo](https://docs.d-api.cloud/api-reference/mensagens/enviar-mensagem-com-vídeo.md): Envia um vídeo com legenda opcional, suporte a video note (ptv) e GIF playback
- [Enviar mensagem com áudio](https://docs.d-api.cloud/api-reference/mensagens/enviar-mensagem-com-áudio.md): Envia um áudio ou nota de voz (ptt) via WhatsApp
- [Enviar mensagem com documento](https://docs.d-api.cloud/api-reference/mensagens/enviar-mensagem-com-documento.md): Envia um documento (PDF, DOC, etc.) via WhatsApp
- [Enviar sticker](https://docs.d-api.cloud/api-reference/mensagens/enviar-sticker.md): Envia um sticker via WhatsApp
- [Enviar localização](https://docs.d-api.cloud/api-reference/mensagens/enviar-localização.md): Envia uma localização com coordenadas GPS via WhatsApp
- [Enviar contato](https://docs.d-api.cloud/api-reference/mensagens/enviar-contato.md): Envia um cartão de contato via WhatsApp
- [Enviar enquete](https://docs.d-api.cloud/api-reference/mensagens/enviar-enquete.md): Envia uma mensagem de enquete com pergunta e opções de resposta
- [Enviar reação](https://docs.d-api.cloud/api-reference/mensagens/enviar-reação.md): Envia uma reação emoji para uma mensagem específica. Envie emoji vazio para remover a reação.
- [Enviar álbum](https://docs.d-api.cloud/api-reference/mensagens/enviar-álbum.md): Envia múltiplas imagens/vídeos como um álbum
- [Enviar template (API Oficial)](https://docs.d-api.cloud/api-reference/mensagens/enviar-template-api-oficial.md): Envia um template aprovado por uma conexão Cloud API. Aceita variáveis do body, variável/mídia de header (url ou base64) e parâmetros de botão em `buttons[]` — o backend monta os components da Graph API.
- [Sincronizar histórico (bulk) via webhook no formato D-API](https://docs.d-api.cloud/api-reference/histórico/sincronizar-histórico-bulk-via-webhook-no-formato-d-api.md): Reenvia em massa o histórico armazenado da instância para o webhook (formato messages.received da D-API). Webhook padrão: o configurado na session (per_event usa o do evento message received); pode sobrescrever com `webhookUrl` (obrigatório se a instância não tem webhook). Inclui mídia quando a mens…
- [Status do history sync (D-API) da instância](https://docs.d-api.cloud/api-reference/histórico/status-do-history-sync-d-api-da-instância.md): Retorna o progresso do último job de history sync (formato D-API) da instância.
- [Solicitar FULL HISTORY SYNC](https://docs.d-api.cloud/api-reference/histórico/solicitar-full-history-sync.md): Dispara um FULL_HISTORY_SYNC_ON_DEMAND via PodWorker
- [Solicitar HISTORY SYNC ON DEMAND](https://docs.d-api.cloud/api-reference/histórico/solicitar-history-sync-on-demand.md): Dispara um HISTORY_SYNC_ON_DEMAND via PodWorker; parâmetro 'count' via query define quantas mensagens buscar (default 50)
- [Enviar mensagem de lista](https://docs.d-api.cloud/api-reference/mensagens-interativas/enviar-mensagem-de-lista.md): Envia uma mensagem de lista interativa (melhor alternativa ao carousel) via WhatsApp
- [Enviar mensagem carousel](https://docs.d-api.cloud/api-reference/mensagens-interativas/enviar-mensagem-carousel.md): Envia uma mensagem carousel com múltiplos cards (máximo 10 cards, 2 botões por card) via WhatsApp
- [Enviar mensagem template](https://docs.d-api.cloud/api-reference/mensagens-interativas/enviar-mensagem-template.md): Envia uma mensagem template com botões CTA (URL e Call) via WhatsApp
- [Enviar mensagem NativeFlow (Mobile apenas)](https://docs.d-api.cloud/api-reference/mensagens-interativas/enviar-mensagem-nativeflow-mobile-apenas.md): Envia uma mensagem NativeFlow com botões interativos (quick_reply, url, call, copy) - APENAS MOBILE via WhatsApp
- [Enviar mensagem com botão PIX](https://docs.d-api.cloud/api-reference/mensagens-interativas/enviar-mensagem-com-botão-pix.md): Envia uma mensagem com botão de cópia PIX (com valor opcional) via WhatsApp
- [Sincronizar etiquetas](https://docs.d-api.cloud/api-reference/etiquetas/sincronizar-etiquetas.md): Dispara um full sync das etiquetas via PodWorker
- [Criar/editar etiqueta](https://docs.d-api.cloud/api-reference/etiquetas/criareditar-etiqueta.md): Cria ou edita uma etiqueta via PodWorker
- [Associar etiqueta a chat](https://docs.d-api.cloud/api-reference/etiquetas/associar-etiqueta-a-chat.md): Associa ou desassocia uma etiqueta a um chat via PodWorker
- [Listar etiquetas](https://docs.d-api.cloud/api-reference/etiquetas/listar-etiquetas.md): Lista etiquetas armazenadas para a sessão informada. Parâmetro includeDeleted aceita 'true' ou 'false' (padrão: false).
- [Listar etiquetas de contato](https://docs.d-api.cloud/api-reference/etiquetas/listar-etiquetas-de-contato.md): Lista etiquetas associadas a um contato específico (por telefone). Parâmetro includeDeleted aceita 'true' ou 'false' (padrão: false).
- [Consultar comando assíncrono](https://docs.d-api.cloud/api-reference/comandos/consultar-comando-assíncrono.md): Consulta o estado e o resultado de um comando enviado com `async: true`, pelo `commandId` retornado no enfileiramento.
- [Listar produtos do catálogo](https://docs.d-api.cloud/api-reference/catálogo/listar-produtos-do-catálogo.md): Lista produtos do catálogo business via comando catalog_list no bridge.
- [Listar coleções do catálogo](https://docs.d-api.cloud/api-reference/catálogo/listar-coleções-do-catálogo.md): Lista coleções do catálogo via comando catalog_collections_list.
- [Buscar produto por ID](https://docs.d-api.cloud/api-reference/catálogo/buscar-produto-por-id.md): Busca um produto único do catálogo via catalog_product_get.
- [Criar produto](https://docs.d-api.cloud/api-reference/catálogo/criar-produto.md): Cria um produto no catálogo business. price/sale_price são decimais (199.90 = R$ 199,90); o backend converte pra unidades × 1000 antes de enviar ao bridge. is_hidden oculta o produto da vitrine (default false).
- [Editar produto](https://docs.d-api.cloud/api-reference/catálogo/editar-produto.md): Edita campos de um produto existente (patch — campos ausentes mantêm o valor atual). price/sale_price são decimais; envie sale_price=0 para remover a promoção. is_hidden alterna visibilidade.
- [Excluir produto](https://docs.d-api.cloud/api-reference/catálogo/excluir-produto.md): Remove um produto do catálogo via catalog_product_delete.
- [Criar coleção](https://docs.d-api.cloud/api-reference/catálogo/criar-coleção.md): Cria uma coleção no catálogo via catalog_collection_create. product_ids opcionalmente já popula a coleção.
- [Editar coleção](https://docs.d-api.cloud/api-reference/catálogo/editar-coleção.md): Edita uma coleção. Quando product_ids é enviado, substitui integralmente os membros da coleção (não é append).
- [Excluir coleção](https://docs.d-api.cloud/api-reference/catálogo/excluir-coleção.md): Remove uma coleção do catálogo via catalog_collection_delete. Os produtos em si não são removidos.
- [Listar chamadas gravadas](https://docs.d-api.cloud/api-reference/calls/listar-chamadas-gravadas.md): Lista as chamadas ao vivo (stream) persistidas com os metadados de gravação, das mais recentes para as mais antigas. Restrito aos dados do titular da API Key. Suporta paginação (page, limit — máximo 100) e os filtros opcionais sessionId, phone e recordingStatus (uploaded | empty | failed).
- [Consultar chamada gravada por id](https://docs.d-api.cloud/api-reference/calls/consultar-chamada-gravada-por-id.md): Retorna uma chamada persistida (metadados de gravação e transcrição, quando disponível) pelo call_id do dapi-go. Restrito aos dados do titular da API Key.
- [Criar link de chamada do WhatsApp](https://docs.d-api.cloud/api-reference/calls/criar-link-de-chamada-do-whatsapp.md): Cria um novo link de chamada do WhatsApp que pode ser compartilhado para chamadas de áudio ou vídeo.
- [Enviar mensagem de chamada agendada](https://docs.d-api.cloud/api-reference/calls/enviar-mensagem-de-chamada-agendada.md): Envia uma mensagem de chamada ou evento agendado para um destinatário. Pode criar um link de chamada do WhatsApp ou usar uma URL própria (Zoom, Meet, etc.).
- [Iniciar chamada de voz](https://docs.d-api.cloud/api-reference/calls/iniciar-chamada-de-voz.md): Inicia uma chamada de voz 1:1 de saída. Responde imediatamente com o callId (estado "calling"); toque, atendimento e desligamento chegam como eventos de webhook call.*.
- [Iniciar chamada de voz ao vivo (stream)](https://docs.d-api.cloud/api-reference/calls/iniciar-chamada-de-voz-ao-vivo-stream.md): Inicia uma chamada 1:1 de saída em modo stream ao vivo e retorna um WebSocket de mídia (wsUrl + token). Conecte o WS para transmitir o áudio do microfone, ouvir o outro lado e receber os eventos do ciclo de vida da chamada. Toda chamada é sempre gravada: um WAV estéreo (microfone/interlocutor) é env…
- [Atender chamada recebida](https://docs.d-api.cloud/api-reference/calls/atender-chamada-recebida.md): Atende uma chamada recebida do WhatsApp em modo stream ao vivo e retorna um WebSocket de mídia (wsUrl + token), no mesmo formato de POST /calls/stream. Conecte o WS para transmitir o áudio do microfone, ouvir quem ligou e receber os eventos do ciclo de vida da chamada. Use o `callId` do evento call.…
- [Recusar chamada recebida](https://docs.d-api.cloud/api-reference/calls/recusar-chamada-recebida.md): Recusa uma chamada recebida do WhatsApp. O campo `from` é o JID de quem ligou exatamente como o evento call.offer informou (pode ser um LID). O evento call.rejected resultante é assíncrono. Indisponível em conexões cloud_api (API Oficial).
- [Encerrar chamada de voz ativa](https://docs.d-api.cloud/api-reference/calls/encerrar-chamada-de-voz-ativa.md): Desliga a chamada ativa. O evento call.ended é assíncrono; este comando apenas dispara o desligamento.
- [Silenciar ou reativar o áudio da chamada](https://docs.d-api.cloud/api-reference/calls/silenciar-ou-reativar-o-áudio-da-chamada.md): Silencia (muted=true) ou reativa (muted=false) o áudio enviado na chamada ativa.
- [Consultar estado da chamada](https://docs.d-api.cloud/api-reference/calls/consultar-estado-da-chamada.md): Retorna o estado atual da chamada no pod (idle | starting | calling | ringing | active | ending | ...).
- [Listar newsletters](https://docs.d-api.cloud/api-reference/newsletters/listar-newsletters.md): Lista todas as newsletters/canais que o usuário está inscrito
- [Criar newsletter](https://docs.d-api.cloud/api-reference/newsletters/criar-newsletter.md): Cria uma nova newsletter/canal. picture pode ser URL ou base64.
- [Consultar limites da conta](https://docs.d-api.cloud/api-reference/account/consultar-limites-da-conta.md): Retorna informações sobre as cotas de mensagens e as restrições da conta (reachout timelock).
- [Disparar ligações URA em massa (áudio ou fluxo IVR)](https://docs.d-api.cloud/api-reference/ligações-ura/disparar-ligações-ura-em-massa-áudio-ou-fluxo-ivr.md)
- [Disparar uma ligação URA (áudio ou fluxo IVR)](https://docs.d-api.cloud/api-reference/ligações-ura/disparar-uma-ligação-ura-áudio-ou-fluxo-ivr.md)
- [Iniciar uma ligação URA ao vivo (Bina Inteligente, cobrança 30/6)](https://docs.d-api.cloud/api-reference/ligações-ura/iniciar-uma-ligação-ura-ao-vivo-bina-inteligente-cobrança-306.md)
- [Enviar um SMS](https://docs.d-api.cloud/api-reference/sms/enviar-um-sms.md)
- [Enviar SMS em massa (mesma mensagem para vários números)](https://docs.d-api.cloud/api-reference/sms/enviar-sms-em-massa-mesma-mensagem-para-vários-números.md)
- [Listar grupos](https://docs.d-api.cloud/api-reference/grupos/listar-grupos.md): Lista todos os grupos do WhatsApp da sessão. Use 'participants=true' para incluir informações dos participantes (padrão: false). Use 'timeout' (em ms) para ajustar o timeout (padrão: 30000ms, máximo: 300000ms)
- [Obter informações do grupo](https://docs.d-api.cloud/api-reference/grupos/obter-informações-do-grupo.md): Obtém informações detalhadas de um grupo específico
- [Criar grupo (Enhanced)](https://docs.d-api.cloud/api-reference/grupos/criar-grupo-enhanced.md): Cria um novo grupo no WhatsApp com participantes e configurações opcionais avançadas (mensagens apenas admin, bloqueio de configurações, descrição, mensagens temporárias, etc.)
- [Gerenciar participantes do grupo](https://docs.d-api.cloud/api-reference/grupos/gerenciar-participantes-do-grupo.md): Adiciona, remove, promove ou rebaixe participantes de um grupo
- [Entrar no grupo](https://docs.d-api.cloud/api-reference/grupos/entrar-no-grupo.md): Entra em um grupo usando o ID do grupo
- [Sair do grupo](https://docs.d-api.cloud/api-reference/grupos/sair-do-grupo.md): Sai de um grupo específico
- [Obter convite do grupo](https://docs.d-api.cloud/api-reference/grupos/obter-convite-do-grupo.md): Obtém o link de convite de um grupo
- [Definir descrição do grupo](https://docs.d-api.cloud/api-reference/grupos/definir-descrição-do-grupo.md): Altera a descrição/tópico de um grupo
- [Definir nome do grupo](https://docs.d-api.cloud/api-reference/grupos/definir-nome-do-grupo.md): Altera o nome (subject) de um grupo
- [Definir foto do grupo](https://docs.d-api.cloud/api-reference/grupos/definir-foto-do-grupo.md): Altera a foto de perfil do grupo. Aceita base64 (data:image/jpeg;base64,...) ou URL da imagem
- [Definir configurações de privacidade do grupo](https://docs.d-api.cloud/api-reference/grupos/definir-configurações-de-privacidade-do-grupo.md): Altera as configurações de privacidade do grupo: - **announce**: true = apenas admins podem enviar mensagens - **locked**: true = apenas admins podem editar informações do grupo - **joinApproval**: true = requer aprovação de admin para entrar - **memberAddMode**: "admin" = apenas admins podem adicio…
- [Revogar link de convite do grupo](https://docs.d-api.cloud/api-reference/grupos/revogar-link-de-convite-do-grupo.md): Revoga o link de convite atual e gera um novo. O link antigo deixará de funcionar
- [Aprovar solicitações de entrada no grupo](https://docs.d-api.cloud/api-reference/grupos/aprovar-solicitações-de-entrada-no-grupo.md): Aprova solicitações de entrada de participantes em um grupo
- [Reprovar solicitações de entrada no grupo](https://docs.d-api.cloud/api-reference/grupos/reprovar-solicitações-de-entrada-no-grupo.md): Reprova solicitações de entrada de participantes em um grupo
- [Editar mensagem](https://docs.d-api.cloud/api-reference/chat/editar-mensagem.md): Edita o texto de uma mensagem específica
- [Listar chats de uma sessão](https://docs.d-api.cloud/api-reference/chat/listar-chats-de-uma-sessão.md): Retorna uma lista simplificada de chats com informações essenciais. Suporta busca inteligente por nome de contato ou telefone normalizado.
- [Busca avançada de chats](https://docs.d-api.cloud/api-reference/chat/busca-avançada-de-chats.md): Busca chats com filtros avançados e suporte a múltiplas sessões.
- [Busca avançada de mensagens](https://docs.d-api.cloud/api-reference/chat/busca-avançada-de-mensagens.md): Busca mensagens com filtros avançados e suporte a múltiplas sessões.
- [Listar mensagens de um chat (simplificado)](https://docs.d-api.cloud/api-reference/chat/listar-mensagens-de-um-chat-simplificado.md): Retorna uma lista simplificada de mensagens de um chat específico com parâmetros essenciais. Suporta busca inteligente por conteúdo da mensagem.
- [Enviar presença](https://docs.d-api.cloud/api-reference/chat/enviar-presença.md): Envia presença global (available/unavailable) ou por chat (typing/recording/paused) via PodWorker. Opcionalmente, para typing/recording, informe 'durationMs' para manter o estado por um tempo antes de pausar automaticamente.
- [Marcar como lidas](https://docs.d-api.cloud/api-reference/chat/marcar-como-lidas.md): Marca mensagens como lidas em um chat via PodWorker
- [Deletar mensagem](https://docs.d-api.cloud/api-reference/chat/deletar-mensagem.md): Deleta uma mensagem específica via PodWorker. Para deletar mensagens de outros usuários (como admin), passe o JID do remetente no campo 'sender'.
- [Obter detalhes de um chat](https://docs.d-api.cloud/api-reference/chat/obter-detalhes-de-um-chat.md): Retorna os detalhes de um chat específico
- [Baixar mídia (unificado)](https://docs.d-api.cloud/api-reference/mídia/baixar-mídia-unificado.md): Baixa qualquer tipo de mídia (imagem, vídeo, áudio, documento) usando as informações de mídia fornecidas. Requer media_key e url ou direct_path. Se 'base64: true', retorna dados em base64. Caso contrário, faz upload para S3 e retorna 'media_url'.
- [Listar todas as sessões](https://docs.d-api.cloud/api-reference/sessões/listar-todas-as-sessões.md): Lista sessões com paginação, busca e filtros
- [Criar ou iniciar uma sessão do WhatsApp](https://docs.d-api.cloud/api-reference/sessões/criar-ou-iniciar-uma-sessão-do-whatsapp.md): Cria uma nova sessão do WhatsApp ou inicia uma existente, conectando o Whatsmeow se necessário
- [Dados de uma sessão](https://docs.d-api.cloud/api-reference/sessões/dados-de-uma-sessão.md): Retorna os dados de uma sessão do WhatsApp, incluindo status e configurações
- [Deletar uma sessão](https://docs.d-api.cloud/api-reference/sessões/deletar-uma-sessão.md): Deleta uma sessão existente e desconecta o WhatsApp se estiver conectado. Aceita tanto o UUID (id) quanto o session_id como parâmetro.
- [Logs de uma sessão](https://docs.d-api.cloud/api-reference/sessões/logs-de-uma-sessão.md): Retorna os logs de uma sessão do WhatsApp, incluindo status e configurações
- [Atualizar webhook de uma sessão](https://docs.d-api.cloud/api-reference/sessões/atualizar-webhook-de-uma-sessão.md): Atualiza a URL do webhook de uma sessão existente. O webhook será usado para receber notificações de eventos da sessão.
- [Salvar configurações do RabbitMQ](https://docs.d-api.cloud/api-reference/sessões/salvar-configurações-do-rabbitmq.md): Salva as configurações de conexão do RabbitMQ para uma sessão específica
- [Salvar configurações do Webhook](https://docs.d-api.cloud/api-reference/sessões/salvar-configurações-do-webhook.md): Salva as configurações de webhook para uma sessão específica
- [Atualizar filtros de mensagens](https://docs.d-api.cloud/api-reference/sessões/atualizar-filtros-de-mensagens.md): Atualiza as configurações ignore_groups e ignore_status da sessão. Elas controlam se mensagens de grupos e atualizações de status são descartadas.
- [Atualizar configurações de chamada](https://docs.d-api.cloud/api-reference/sessões/atualizar-configurações-de-chamada.md): Atualiza as configurações reject_calls e reject_calls_message da sessão. Elas controlam a recusa automática de chamadas e a mensagem de resposta automática.
- [Atualizar marcação automática como lida](https://docs.d-api.cloud/api-reference/sessões/atualizar-marcação-automática-como-lida.md): Atualiza a configuração mark_previous_as_read da sessão. Quando ativada, as mensagens anteriores são marcadas como lidas automaticamente após o envio de uma mensagem.
- [Atualizar uso do código do Brasil](https://docs.d-api.cloud/api-reference/sessões/atualizar-uso-do-código-do-brasil.md): Atualiza a configuração assume_br_country_code. Quando ativada, as rotas de envio assumem Brasil (+55) para números sem código do país (com validação de DDD).
- [Atualizar armazenamento de mensagens](https://docs.d-api.cloud/api-reference/sessões/atualizar-armazenamento-de-mensagens.md): Atualiza a configuração disable_message_storage. Quando ativada, o conteúdo das mensagens NÃO é persistido no banco para esta conexão. Os contatos continuam sendo armazenados (para resolução de LID) e os webhooks não são afetados.
- [Atualizar recebimento de chamadas](https://docs.d-api.cloud/api-reference/sessões/atualizar-recebimento-de-chamadas.md): Ativa ou desativa o recebimento e o atendimento de chamadas do WhatsApp nesta conexão. Desativado por padrão: ao ativar, o bridge pré-aceita as chamadas recebidas, o que sobe a mídia mesmo para chamadas que ninguém atende. Ative apenas se o seu sistema for tratar os eventos call.offer (com POST /cal…
- [Atualizar modo de entrega de comandos](https://docs.d-api.cloud/api-reference/sessões/atualizar-modo-de-entrega-de-comandos.md): Atualiza o modo de entrega de comandos da sessão. 'rabbitmq' (padrão) usa a fila de mensagens; 'http' envia os comandos direto ao pod, com a fila como fallback. Use 'http' para testes com menor latência.
- [Reconectar uma sessão com restart do pod](https://docs.d-api.cloud/api-reference/sessões/reconectar-uma-sessão-com-restart-do-pod.md): Força a reconexão de uma sessão existente reiniciando o pod Kubernetes e usando o webhookUrl configurado na sessão. Se o restart do pod falhar, executa um fallback com reconexão simples.
- [Desconectar uma sessão](https://docs.d-api.cloud/api-reference/sessões/desconectar-uma-sessão.md): Desconecta uma sessão existente do WhatsApp sem deletá-la do banco de dados
- [Obter o QR code de uma sessão](https://docs.d-api.cloud/api-reference/sessões/obter-o-qr-code-de-uma-sessão.md): Retorna os dados do QR code de uma sessão. Use ?image=1 para obter o QR code como uma imagem PNG diretamente.
- [Passkey connect disponível?](https://docs.d-api.cloud/api-reference/sessões/passkey-connect-disponível?.md): Reporta se o modo de conexão por passkey (WebAuthn) está habilitado.
- [Obter o desafio WebAuthn (passkey) de uma sessão](https://docs.d-api.cloud/api-reference/sessões/obter-o-desafio-webauthn-passkey-de-uma-sessão.md): Retorna o PublicKeyCredentialRequestOptions emitido pelo bridge para assinatura pela extensão, e o código de confirmação quando disponível.
- [Enviar a assinatura WebAuthn (passkey) de uma sessão](https://docs.d-api.cloud/api-reference/sessões/enviar-a-assinatura-webauthn-passkey-de-uma-sessão.md): Encaminha a assertion assinada ao bridge (SendPasskeyResponse) para concluir o pareamento por passkey.
- [Gerar código de fallback para passkey (popup)](https://docs.d-api.cloud/api-reference/sessões/gerar-código-de-fallback-para-passkey-popup.md): Gera um código curto de uso único (TTL 5min) que o usuário digita na extensão para concluir o passkey quando o caminho page-callable não está disponível.
- [Obter o código de pareamento de uma sessão](https://docs.d-api.cloud/api-reference/sessões/obter-o-código-de-pareamento-de-uma-sessão.md): Retorna os dados do código de pareamento de uma sessão configurada para usar pareamento por código.
- [Importar sessão migrada do WhatsApp Web](https://docs.d-api.cloud/api-reference/sessões/importar-sessão-migrada-do-whatsapp-web.md)
- [Gerar código único de migração do WhatsApp Web](https://docs.d-api.cloud/api-reference/sessões/gerar-código-único-de-migração-do-whatsapp-web.md)
- [Obter o desafio de passkey por código (fallback popup)](https://docs.d-api.cloud/api-reference/sessões/obter-o-desafio-de-passkey-por-código-fallback-popup.md)
- [Enviar a assinatura de passkey por código (fallback popup)](https://docs.d-api.cloud/api-reference/sessões/enviar-a-assinatura-de-passkey-por-código-fallback-popup.md)
- [Obter uma conexão cloud_api](https://docs.d-api.cloud/api-reference/cloud-api/obter-uma-conexão-cloud_api.md): Retorna uma conexão cloud_api (WhatsApp API Oficial). O `id` aceita o id da conexão OU o id da sessão (`cloud-<uuid>`). `data` traz os detalhes da conexão (waba id, phone number id, telefone exibido, nome verificado, roteamento de webhook, saúde). Retorna 404 se a conexão não existir ou não pertence…
- [Atualizar conexão cloud_api](https://docs.d-api.cloud/api-reference/cloud-api/atualizar-conexão-cloud_api.md): Atualiza o roteamento de webhook (webhookUrl, webhookMode) e/ou rotaciona o access token da Meta. `webhookMode` é `normalized` (eventos canônicos da D-API) ou `meta_passthrough` (payloads brutos da Meta). Pelo menos um campo deve ser enviado. O token é recriptografado com AES-256-GCM na gravação.
- [Listar templates aprovados da WABA](https://docs.d-api.cloud/api-reference/cloud-api/listar-templates-aprovados-da-waba.md): Lista os templates de mensagem APROVADOS da WhatsApp Business Account da conexão. `data` é um array de templates (name, language, category, status, components) como retornados pela Meta. Use esses valores de `name`/`language` ao enviar via POST /messages/send/template.
- [Criar template de mensagem na WABA](https://docs.d-api.cloud/api-reference/cloud-api/criar-template-de-mensagem-na-waba.md): Envia um novo template de mensagem para revisão da Meta. `name` deve estar em snake_case minúsculo; `category` é MARKETING, UTILITY ou AUTHENTICATION; `language` é um código de idioma da Meta (ex.: pt_BR). Os marcadores do corpo usam {{1}}, {{2}}… e `bodyExample` fornece um valor de exemplo para cad…
- [Listar todos os templates da WABA (qualquer status)](https://docs.d-api.cloud/api-reference/cloud-api/listar-todos-os-templates-da-waba-qualquer-status.md): Lista TODOS os templates de mensagem da WABA da conexão, independentemente do status de revisão (APPROVED, PENDING, REJECTED, etc.) — use em telas de gestão. `data` é um array de templates da Meta, incluindo o `status` de cada um.
- [Excluir template da WABA pelo nome](https://docs.d-api.cloud/api-reference/cloud-api/excluir-template-da-waba-pelo-nome.md): Exclui um template de mensagem da WABA da conexão pelo nome — isso remove TODAS as variantes de idioma desse template. Retorna `{ success: true }` ao concluir.
- [Obter o access token da Meta descriptografado](https://docs.d-api.cloud/api-reference/cloud-api/obter-o-access-token-da-meta-descriptografado.md): Retorna o access token da Meta armazenado para uma conexão cloud_api, DESCRIPTOGRAFADO, e o tipo do token. O `id` aceita o id da conexão ou o id da sessão (`cloud-<uuid>`).
- [Criar conexão cloud_api manualmente](https://docs.d-api.cloud/api-reference/cloud-api/criar-conexão-cloud_api-manualmente.md): Cria uma conexão do WhatsApp API Oficial a partir de waba id, phone number id e access token informados manualmente (gerados no Meta Business Manager). Valida o par (número, token) na Graph API, tenta inscrever o app para webhooks e então provisiona a conexão e sincroniza a cobrança Scale. `data` é…
- [Obter blocklist](https://docs.d-api.cloud/api-reference/contacts/obter-blocklist.md): Retorna a lista de contatos bloqueados (JIDs e phones)
- [Atualizar blocklist](https://docs.d-api.cloud/api-reference/contacts/atualizar-blocklist.md): Bloqueia ou desbloqueia um contato (update_blocklist)
- [Reportar contato](https://docs.d-api.cloud/api-reference/contacts/reportar-contato.md): Reporta um contato ao WhatsApp e, opcionalmente, bloqueia (report_contact). Resposta em data: { report: { status, report_id?, error? }, block?: { status, blocklist?, error? } }. success=true no envelope significa que o bridge atendeu o pedido — não que ambos sub-steps deram certo. report.status='ok'…
- [Listar contatos](https://docs.d-api.cloud/api-reference/contacts/listar-contatos.md): Lista todos os contatos da agenda do WhatsApp
- [Obter informações do usuário](https://docs.d-api.cloud/api-reference/contacts/obter-informações-do-usuário.md): Obtém os dados de um contato. Campos: jid, phone, lid, contactName (nome salvo na sua agenda), pushName (nome que o contato publica: perfil, negócio ou nome verificado), username (@ do WhatsApp), isBusiness (conta WhatsApp Business no celular), isOfficial (conta hospedada na Meta, ou seja, API Ofici…
- [Obter avatar do usuário](https://docs.d-api.cloud/api-reference/contacts/obter-avatar-do-usuário.md): Obtém o avatar de um usuário específico. Use force=true para ignorar cache e buscar direto do WhatsApp.
- [Verificar usuários](https://docs.d-api.cloud/api-reference/contacts/verificar-usuários.md): Verifica se números de telefone estão registrados no WhatsApp
- [Obter informações do usuário](https://docs.d-api.cloud/api-reference/contacts/obter-informações-do-usuário-1.md): Mesma resposta de GET /contacts/{phone}: contato enriquecido com nomes, dados de negócio e avatar.
- [Migrar sessão do WhatsApp Web com código único](https://docs.d-api.cloud/api-reference/migração/migrar-sessão-do-whatsapp-web-com-código-único.md)

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.