Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.waspytech.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Scopes disponibles

Cada API key puede tener uno o más scopes que limitan qué operaciones puede hacer. Si no asignás scopes al crear la key, tiene acceso completo.
ScopeDescripciónEndpoints
account:readLeer información de la cuentaGET /account
channels:readListar canales (números) conectadosGET /channels
contacts:readLeer contactosGET /contacts, GET /contacts/:id
contacts:writeCrear y actualizar contactosPOST /contacts, PATCH /contacts/:id
conversations:readLeer conversaciones y sus mensajesGET /conversations, GET /conversations/:id, GET /conversations/:id/messages
conversations:writeActualizar conversación, mark-as-read, typingPATCH /conversations/:id, POST /conversations/:id/read, POST /conversations/:id/typing, POST /messages/:waMessageId/read
messages:readLeer mensajes individualesGET /messages/:id
messages:writeEnviar mensajesPOST /messages
templates:readListar y consultar templatesGET /templates, GET /templates/:id, GET /templates/by-name/:name
media:readResolver media a signed URLsGET /media/:id, GET /media/by-key
media:writeSubir media (no expuesto todavía — ver Limitaciones)—
webhooks:readLeer suscripciones y deliveriesGET /webhooks, GET /webhooks/:id, GET /webhooks/:id/deliveries
webhooks:writeCrear/modificar suscripciones, rotate-secret, test, replayPOST /webhooks, PATCH /webhooks/:id, DELETE /webhooks/:id, POST /webhooks/:id/test, POST /webhooks/:id/replay/:deliveryId, POST /webhooks/:id/rotate-secret
Superposición conversations:read ↔ messages:read: GET /conversations/:id/messages requiere conversations:read (porque listás los mensajes “de una conversación”), mientras que GET /messages/:id requiere messages:read (porque accedés a un mensaje “individual”). Para keys de solo lectura, lo común es asignar ambos.

​
Cómo funcionan

  • Una key sin scopes puede hacer todo (acceso completo).
  • Una key con scopes solo puede acceder a los endpoints correspondientes.
  • Si una key intenta acceder a un endpoint sin el scope necesario, recibe un 403:
{
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "Esta API key no tiene permiso para esta operación.",
    "status": 403
  },
  "meta": { "requestId": "..." }
}

​
Ejemplos de uso

​
Key de solo lectura

Para un dashboard que solo consulta datos: 
Scopes: account:read, contacts:read, conversations:read, templates:read

​
Key para enviar mensajes

Para un sistema que envía notificaciones: 
Scopes: messages:write, contacts:read, templates:read

​
Key de gestión de contactos

Para un CRM que sincroniza contactos: 
Scopes: contacts:read, contacts:write

​
Relación con el plan

Los scopes limitan qué puede hacer una API key, pero los límites del plan aplican a toda la cuenta. Si tu plan tiene un límite de 1.000 conversaciones/mes, ese límite se aplica sin importar los scopes de la key.