Skip to main content
La clave API es la tarjeta de acceso del edificio: cada alcance abre una puerta. En producción, conceda solo lo que su integración necesita.

​
En breve

  • Cada clave pertenece a un espacio de trabajo.
  • Los alcances whatsapp:* cubren instancias, envío y lectura del canal.
  • El campo instanceIds restringe qué números puede usar la clave.
  • Contactos, etiquetas y plantillas multicanal usan alcances aparte (solo si los necesita).
Guía general: Claves API. Conexión: Inicio rápido.

​
Cómo enviar la clave

Alternativa: x-api-key: sk_live_xxxxx.
Alcances vacíos al crear = acceso ADMIN (todo). En producción, restrinja siempre.

​
Combinaciones listas

Conectar y enviar

whatsapp:instances:create, whatsapp:instances:list, whatsapp:send

Solo enviar

whatsapp:send + instanceIds con el id del número

Bot / soporte

whatsapp:send, whatsapp:read

Operar el número

whatsapp:instances:list, whatsapp:instances:disconnect, whatsapp:instances:delete

​
Alcances disponibles

Listar instancias, ver detalles y obtener código/QR.
Crear instancia (oficial o no oficial, con o sin enlace compartible).
Desconectar sesión activa.
Eliminar instancia (solo cuando esté desconectada).
Enviar texto, medios, plantillas, botones y listas.
Historial de enviados, estado por id y mensajes recibidos (inbound).
Editar mensaje enviado.
Cancelar programado o en cola.
Eliminar para todos.
Grupos, participantes, invitaciones y envío a JID de grupo. Requiere instancia no oficial. Guía: Grupos WhatsApp.

​
Restringir por número (instanceIds)

Además del alcance (el qué), instanceIds define dónde: Ejemplo: ERP que solo envía desde soporte → whatsapp:send + instanceIds: ["clxx123..."].

​
Otros alcances (si los necesita)

Enviar por plantilla (POST /v1/templates/send) usa whatsapp:send (y otros canales), no templates:*. Detalles: Alcances de plantillas.

​
Errores comunes

Más códigos: Respuestas de error.

​
Próximos pasos