Referência da API
Referência da API de WhatsApp por endpoint
Cada endpoint da API REST do ZapZap em uma página própria, com método, caminho, parâmetros, exemplos de requisição em curl, Node.js e Python e a resposta de exemplo. 153 endpoints em 17 categorias.
Autenticação
Toda requisição usa os cabeçalhos x-api-key e x-api-secret, obtidos no painel em Configurações e API.
Base URL
Operações de uma instância usam /api/v1/{instanceId}/...; gestão de conta e instâncias usa /api/v1/instances, /api/v1/account e afins.
Os caminhos são relativos a https://api.zapzapapi.com/api/v1. Troque {instanceId} pelo ID da instância mostrado no painel.
Conta e Instâncias
- GET/accountDados da Conta
- GET/instancesListar Instâncias
- POST/instancesCriar Instância
- GET/instances/costCusto de Criação
- DELETE/instances/{id}Deletar Instância
- GET/instances/{id}Detalhes da Instância
- PUT/instances/{id}Atualizar Instância
- GET/instances/{id}/qrcodeQR Code da Instância
- GET/instances/{id}/webhookVer Webhook
- PUT/instances/{id}/webhookConfigurar Webhook
- POST/instances/{id}/webhook/testTestar Webhook
- GET/{instanceId}/instance/wa_messages_limitsLimites de Novas Conversas (WhatsApp)
Enviar Mensagens
- POST/{instanceId}/send/carouselEnviar Carrossel
- POST/{instanceId}/send/contactEnviar Contato (vCard)
- POST/{instanceId}/send/locationEnviar Localização
- POST/{instanceId}/send/location-buttonSolicitar Localização
- POST/{instanceId}/send/mediaEnviar Mídia
- POST/{instanceId}/send/buttonsEnviar Botões de Resposta
- POST/{instanceId}/send/listEnviar Lista de Opções
- POST/{instanceId}/send/pollEnviar Enquete
- POST/{instanceId}/send/pix-buttonEnviar Botão PIX
- POST/{instanceId}/send/request-paymentSolicitar Pagamento
- POST/{instanceId}/send/statusEnviar Status / Story
- POST/{instanceId}/send/textEnviar Texto
Conversas
- POST/{instanceId}/chat/archiveArquivar Chat
- POST/{instanceId}/chat/blockBloquear / Desbloquear Contato
- GET/{instanceId}/chat/blocklistLista de Bloqueados
- POST/{instanceId}/chat/deleteDeletar Chat
- POST/{instanceId}/chat/findBuscar Chats
- POST/{instanceId}/chat/muteSilenciar Chat
- POST/{instanceId}/chat/notesVer Notas do Chat
- POST/{instanceId}/chat/notes/editEditar Notas do Chat
- POST/{instanceId}/chat/notes/refreshRecarregar Notas
- POST/{instanceId}/chat/pinFixar / Desfixar Chat
- POST/{instanceId}/chat/readMarcar Chat como Lido
- POST/{instanceId}/message/deleteDeletar Mensagem
- POST/{instanceId}/message/downloadDownload de Mídia
- POST/{instanceId}/message/editEditar Mensagem
- POST/{instanceId}/message/findHistórico de Mensagens
- POST/{instanceId}/message/history-syncSincronizar Histórico
- POST/{instanceId}/message/markreadMarcar como Lida
- POST/{instanceId}/message/presenceIndicador de Digitando...
- POST/{instanceId}/message/reactReagir com Emoji
- POST/{instanceId}/chat/ephemeralMensagens Temporárias (conversa privada)
Contatos e Perfil
- POST/{instanceId}/chat/checkVerificar Número
- POST/{instanceId}/chat/detailsDetalhes do Contato
- POST/{instanceId}/contact/addAdicionar Contato
- POST/{instanceId}/contact/removeRemover Contato
- GET/{instanceId}/contactsListar Contatos (Rápido)
- POST/{instanceId}/contacts/listListar Contatos
- POST/{instanceId}/profile/imageAlterar Foto
- POST/{instanceId}/profile/nameAlterar Nome
Grupos
- POST/{instanceId}/community/createCriar Comunidade
- POST/{instanceId}/community/editgroupsGerenciar Grupos da Comunidade
- POST/{instanceId}/group/createCriar Grupo
- POST/{instanceId}/group/infoInformações do Grupo
- POST/{instanceId}/group/inviteInfoInfo pelo Convite
- POST/{instanceId}/group/joinEntrar em Grupo via Link
- POST/{instanceId}/group/leaveSair do Grupo
- GET/{instanceId}/group/listListar Grupos
- POST/{instanceId}/group/listBuscar Grupos
- POST/{instanceId}/group/resetInviteCodeResetar Código de Convite
- POST/{instanceId}/group/updateAnnounceModo Somente Admins
- POST/{instanceId}/group/updateDescriptionAlterar Descrição do Grupo
- POST/{instanceId}/group/updateImageAlterar Foto do Grupo
- POST/{instanceId}/group/updateLockedBloquear Edição do Grupo
- POST/{instanceId}/group/updateNameRenomear Grupo
- POST/{instanceId}/group/updateParticipantsGerenciar Participantes
- POST/{instanceId}/group/ephemeralMensagens Temporárias (grupo)
- POST/{instanceId}/group/updateJoinApprovalExigir Aprovação para Entrar
- POST/{instanceId}/group/updateMemberAddModeQuem Pode Adicionar Membros
Newsletters e Canais
- POST/{instanceId}/newsletter/admin/acceptAceitar Convite de Admin
- POST/{instanceId}/newsletter/admin/inviteConvidar Admin do Canal
- POST/{instanceId}/newsletter/admin/removeRemover Admin do Canal
- POST/{instanceId}/newsletter/admin/revokeRevogar Convite de Admin
- POST/{instanceId}/newsletter/createCriar Canal
- POST/{instanceId}/newsletter/deleteDeletar Canal
- POST/{instanceId}/newsletter/descriptionAlterar Descrição do Canal
- POST/{instanceId}/newsletter/followSeguir Canal
- POST/{instanceId}/newsletter/infoInfo do Canal
- POST/{instanceId}/newsletter/linkBuscar Canal por Link
- GET/{instanceId}/newsletter/listListar Canais
- POST/{instanceId}/newsletter/messagesMensagens do Canal
- POST/{instanceId}/newsletter/messages/deleteDeletar Mensagem do Canal
- POST/{instanceId}/newsletter/messages/editEditar Mensagem do Canal
- POST/{instanceId}/newsletter/muteSilenciar Canal
- POST/{instanceId}/newsletter/nameAlterar Nome do Canal
- POST/{instanceId}/newsletter/owner/transferTransferir Dono do Canal
- POST/{instanceId}/newsletter/pictureAlterar Foto do Canal
- POST/{instanceId}/newsletter/reactionReagir a Post do Canal
- POST/{instanceId}/newsletter/searchPesquisar Canais
- POST/{instanceId}/newsletter/settingsConfigurações do Canal
- POST/{instanceId}/newsletter/subscribeAssinar Updates do Canal
- POST/{instanceId}/newsletter/unfollowDeixar de Seguir
- POST/{instanceId}/newsletter/unmuteReativar Canal
- POST/{instanceId}/newsletter/updatesUpdates do Canal
- POST/{instanceId}/newsletter/viewedMarcar como Visualizado
Campanhas
- POST/{instanceId}/sender/advancedDisparar Campanha em Lote
- DELETE/{instanceId}/sender/clearallLimpar Toda a Fila
- POST/{instanceId}/sender/cleardoneLimpar Campanhas Concluídas
- POST/{instanceId}/sender/editControlar Campanha
- GET/{instanceId}/sender/listfoldersListar Campanhas
- POST/{instanceId}/sender/listmessagesListar Mensagens da Campanha
- POST/{instanceId}/sender/simpleDisparar Mensagem Simples
WhatsApp Business
- POST/{instanceId}/business/catalog/deleteDeletar Produto do Catálogo
- POST/{instanceId}/business/catalog/hideOcultar Produto do Catálogo
- POST/{instanceId}/business/catalog/infoInfo do Produto
- POST/{instanceId}/business/catalog/listListar Catálogo de Produtos
- POST/{instanceId}/business/catalog/showExibir Produto no Catálogo
- GET/{instanceId}/business/get/categoriesListar Categorias Comerciais
- POST/{instanceId}/business/get/profileVer Perfil Comercial
- POST/{instanceId}/business/update/profileAtualizar Perfil Comercial
Configurações
- POST/{instanceId}/chat/labelsAplicar Etiqueta ao Chat
- POST/{instanceId}/instance/connectConectar Instância
- POST/{instanceId}/instance/disconnectDesconectar Instância
- POST/{instanceId}/instance/presenceStatus de Presença
- GET/{instanceId}/instance/privacyVer Privacidade
- POST/{instanceId}/instance/privacyAlterar Privacidade
- GET/{instanceId}/instance/proxyVer Proxy
- POST/{instanceId}/instance/proxyConfigurar Proxy
- POST/{instanceId}/instance/resetReiniciar Instância
- GET/{instanceId}/instance/statusInformações & Status da Instância
- POST/{instanceId}/instance/updateDelaySettingsConfigurar Delay
- POST/{instanceId}/instance/updateInstanceNameRenomear Instância
- POST/{instanceId}/label/editCriar / Editar Etiqueta
- GET/{instanceId}/labelsListar Etiquetas
- POST/{instanceId}/labels/refreshRecarregar Etiquetas
- POST/{instanceId}/quickreply/editCriar / Editar Resposta Rápida
- GET/{instanceId}/quickreply/showallListar Respostas Rápidas
Webhooks e Eventos
Fila Async
Chatbot e IA
- POST/{instanceId}/agent/editCriar/Editar Agente IA
- GET/{instanceId}/agent/listListar Agentes IA
- POST/{instanceId}/function/editCriar/Editar Função API
- GET/{instanceId}/function/listListar Funções API
- POST/{instanceId}/knowledge/editCriar/Editar Conhecimento
- GET/{instanceId}/knowledge/listListar Conhecimentos
- POST/{instanceId}/trigger/editCriar/Editar Trigger
- GET/{instanceId}/trigger/listListar Triggers
CRM e Leads
Integração Chatwoot
Pegue suas chaves de API
Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.