Pular para o conteúdo
atendroZAP Documentação
OpenAPI ↗Para IA ↗Abrir console ↗
/

Visão geral ↗
›Começar a integrar10
Primeiros passosServidores e autenticaçãoCiclo de vida da instânciaConfigurar webhooksImplementar o receptorPayloads e entrega de eventosErros e idempotênciaChamadas de vozCompatibilidadeValidação e limites
Referência da API 64
›Diagnóstico3
GETVerificar processo HTTPGETVerificar banco acessívelGETConsultar capacidades
›Instâncias7
POSTCriar instância e emitir tokenGETListar instâncias do servidorPOSTConectar ou iniciar pareamentoGETConsultar sessão e webhookPOSTDesvincular e limpar credencialPOSTReiniciar preservando credencialDELETEExcluir instância
›Administração7
GETConsultar instância por IDDELETEExcluir instância por IDPOSTConectar instância por IDPOSTDesvincular instância por IDPOSTReiniciar instância por IDPOSTReemitir token da instânciaPOSTReiniciar sessões deste worker
›Enviar mensagens5
POSTEnviar textoPOSTEnviar mídiaPOSTEnviar contatoPOSTEnviar localizaçãoPOSTEnviar botões, lista ou enquete
›Ações em mensagens5
POSTEncaminhar mensagem guardadaPOSTReagir ou remover reaçãoPOSTApagar mensagem própria para todosPOSTEditar texto ou legenda própriaPUTEditar mensagem (alias PUT)
›Conversas e consultas6
POSTBuscar mensagens no formato legadoGETConsultar resultado da mensagemGETListar mensagens no formato internoPOSTVerificar números no WhatsAppPOSTObter identidade e fotoPOSTListar conversas conhecidas
›Mídia2
POSTObter link assinado de mídiaGETLer bytes pelo link assinado
›Leitura2
POSTEnviar recibos de leitura por IDPOSTMarcar recebidas do chat como lidas
›Grupos6
GETListar grupos sincronizadosPOSTConsultar grupoPOSTCriar grupoPOSTAlterar participantesPOSTAlterar nome do grupoPOSTAlterar imagem do grupo
›Proxy da instância2
GETConsultar proxy da instânciaPOSTConfigurar proxy ou conexão direta
›Webhooks e eventos10
POSTConfigurar, desativar ou herdar webhookGETConsultar webhook e entregaGETConsultar falhas recentes de entregaGETInspecionar eventos internos e filaPOSTReenfileirar eventoPOSTSalvar ou remover webhook globalGETConsultar webhook globalPOSTConfigurar, desativar ou herdar webhook por IDGETConsultar webhook e entrega por IDGETConsultar falhas recentes de entrega por ID
›Chamadas de voz9
POSTIniciar ligação por instância callsPOSTAtender ligação recebidaPOSTRecusar ligação recebidaPOSTEncerrar ligaçãoGETListar ligações ativasGETConsultar estado de ligaçãoGETAbrir ponte WebSocket de áudioGETConsultar histórico de chamadasGETOuvir ou baixar gravação
Estruturas de dados 77
›Modelos de dados77
ErrorHealthCapabilitiesInstanceIssuedInstanceConnectionInitRequestInitResultConnectRequestDisconnectResultRestartResultResponseMessageTokenRequestTokenResultSendTextRequestSendMediaRequestSendContactRequestSendLocationRequestSendMenuRequestSendResultSendMediaResultSendMenuResultReactRequestDeleteMessageRequestEditRequestForwardRequestReactResultDeleteMessageResultEditResultFindMessagesRequestLegacyMessageFindMessagesResultMessageStatusStoredMessageListMessagesResultDownloadRequestDownloadResultMarkReadRequestMarkReadResultChatReadRequestChatReadResultCheckRequestNumberCheckDetailsRequestChatDetailsFindChatsRequestChatFindChatsResultGroupParticipantGroupGroupInfoRequestCreateGroupRequestGroupParticipantsRequestGroupParticipantsResultGroupNameRequestGroupImageRequestGroupUpdateResultProxyRequestProxyProxyResultWebhookRequestDeliveryStatusWebhookWebhookWriteResultWebhookErrorsEventEventsResultReplayResultAdminRestartResultGlobalWebhookRequestGlobalWebhookMakeCallRequestCallActionRequestCallActiveCallsCallRecordingCallHistory
Contrato 2026-09-17Validação e limites ↗
Docs/Referência da API
Markdown ↗

Mídia

Baixe arquivos e use URLs assinadas com prazo de validade.

Baixe arquivos e use URLs assinadas com prazo de validade.

Operações

  • POST /message/download: Obter link assinado de mídia.
  • GET /v1/media/{token}: Ler bytes pelo link assinado.
AtendroZAP · Referência de integraçãoEstado da validação ↗
Nesta página
Operações
Para seu assistente de IA

O mesmo contrato, em texto.

Índice de documentação ↗Conteúdo completo ↗