Catalisa.Building Blocks

API do WPP

45 endpoints em 8 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

47 endpoints

Devices

/wpp/api/v1/devices13
  • POST/wpp/api/v1/devicesCria o device. 201WPP_ADMIN
  • GET/wpp/api/v1/devicesLista, paginado. Filtros filter[status], filter[driver]WPP_READ
  • GET/wpp/api/v1/devices/:idBusca por **UUID interno**WPP_READ
  • DELETE/wpp/api/v1/devices/:idRemove por **UUID interno**. 204WPP_ADMIN
  • POST/wpp/api/v1/devices/:deviceId/connectEnfileira conexão. 202WPP_ADMIN
  • POST/wpp/api/v1/devices/:deviceId/disconnectEnfileira desconexão. 202WPP_ADMIN
  • POST/wpp/api/v1/devices/:deviceId/reconnectEnfileira reconexão. 202WPP_ADMIN
  • POST/wpp/api/v1/devices/:deviceId/resetDescarta a sessão e força novo pareamento. 202WPP_ADMIN
  • POST/wpp/api/v1/devices/:deviceId/pingSonda a conectividade do socket. 202WPP_READ
  • POST/wpp/api/v1/devices/:deviceId/pairing-codePede código de 8 caracteres. 202WPP_ADMIN
  • GET/wpp/api/v1/devices/:deviceId/pairing-codeLê o código já geradoWPP_READ
  • GET/wpp/api/v1/devices/:deviceId/qrLê o QR correnteWPP_READ
  • GET/wpp/api/v1/devices/:deviceId/statusSó o statusWPP_READ

Mensagens

/wpp/api/v1/messages9
  • POST/wpp/api/v1/messages/sendTexto. 202WPP_SEND
  • POST/wpp/api/v1/messages/send-mediaImagem, vídeo, áudio, documento, figurinha. 202WPP_SEND
  • POST/wpp/api/v1/messages/send-reactionReação a uma mensagem. 202WPP_SEND
  • POST/wpp/api/v1/messages/send-templateTemplate. 202 — **ver §15**WPP_SEND
  • POST/wpp/api/v1/messages/send-locationLocalização. 202WPP_SEND
  • POST/wpp/api/v1/messages/send-contactCartão de contato. 202WPP_SEND
  • GET/wpp/api/v1/messagesLista com filtrosWPP_READ
  • GET/wpp/api/v1/messages/media/:messageIdMaterializa a mídia. 302 ou 202WPP_READ
  • GET/wpp/api/v1/messages/:idBusca por **UUID interno**WPP_READ

Conversas e contatos

/wpp/api/v1/chats2
  • GET/wpp/api/v1/chatsLista conversas. Filtros filter[type], filter[archived]WPP_READ
  • GET/wpp/api/v1/chats/contactsLista contatos. **deviceId é obrigatório**WPP_READ

Grupos

/wpp/api/v1/groups9
  • POST/wpp/api/v1/groupsCria grupo. 202WPP_ADMIN
  • GET/wpp/api/v1/groupsLista, paginadoWPP_READ
  • GET/wpp/api/v1/groups/:idBusca grupo com participantesWPP_READ
  • GET/wpp/api/v1/groups/:groupJid/participantsSó os participantesWPP_READ
  • PUT/wpp/api/v1/groups/:groupJid/subjectRenomeia. 202WPP_ADMIN
  • PUT/wpp/api/v1/groups/:groupJid/descriptionAltera a descrição. 202WPP_ADMIN
  • POST/wpp/api/v1/groups/:groupJid/participantsAdiciona, remove, promove, rebaixa. 202WPP_ADMIN
  • POST/wpp/api/v1/groups/:groupJid/leaveSai do grupo. 202WPP_ADMIN
  • DELETE/wpp/api/v1/groups/:groupJidEncerra o grupo. 202. Exige deviceId no corpoWPP_ADMIN

Configuração

/wpp/api/v1/config2
  • GET/wpp/api/v1/configConfiguração da organizaçãoWPP_READ
  • PATCH/wpp/api/v1/configAltera a configuraçãoWPP_ADMIN

Operações

/wpp/api/v1/operations2
  • GET/wpp/api/v1/operationsLista. Filtro filter[status]WPP_READ
  • GET/wpp/api/v1/operations/:correlationIdResultado de uma operaçãoWPP_READ

Dispatchers

/wpp/api/v1/dispatchers8
  • POST/wpp/api/v1/dispatchersCria e provisiona a assinatura no Webhooks Engine. 201WPP_DISPATCHERS_WRITE
  • GET/wpp/api/v1/dispatchersLista. limit, offset, statusWPP_DISPATCHERS_READ
  • GET/wpp/api/v1/dispatchers/:idBuscaWPP_DISPATCHERS_READ
  • PATCH/wpp/api/v1/dispatchers/:idAltera e ressincroniza a assinaturaWPP_DISPATCHERS_WRITE
  • DELETE/wpp/api/v1/dispatchers/:id**Exclusão lógica** — deletedAt preenchido, assinatura desabilitada, logs preservados. 204WPP_DISPATCHERS_WRITE
  • POST/wpp/api/v1/dispatchers/:id/toggleAlterna ACTIVE ↔ PAUSED. **Evento recebido enquanto pausado é descartado**, não enfileiradoWPP_DISPATCHERS_WRITE
  • GET/wpp/api/v1/dispatchers/:id/delivery-logsLog de entregas. page, pageSize, status ∈ PENDING · DELIVERED · FAILED · RETRYINGWPP_DISPATCHERS_READ
  • POST/wpp/api/v1/dispatchers/:id/delivery-logs/:logId/retryReenvia uma entrega, ignorando o backoffWPP_DISPATCHERS_WRITE

Saúde e eventos ao vivo

2
  • GET/wpp/healthAPISonda de vida do serviço HTTP
  • GET/api/v1/events/:organizationId**SSE** (processo separado)Stream Server-Sent Events da organização