v1

latestOpenAPI 3.0.3Proprietary2026-08-0610636149.4 KB

Listar canales con WhatsApp

Lista los canales vinculados al token que tienen capacidad WhatsApp HSM. Es el endpoint de descubrimiento: el id de cada canal es el channelId que se usa en el resto de operaciones /v1/whatsapp/{channelId}/*.

Cada canal viene enriquecido con:

provider: proveedor HSM derivado del canal (gupshup, meta_cloud, o null si no tiene proveedor HSM).
hsmLineStatus: estado de la línea — active (línea provisionada, lista para enviar), null (sin línea dada de alta), error (fallo transitorio al resolver ese canal). Solo enviar HSM cuando es active.

get/v1/whatsapp

Response

Lista de canales con configuración WhatsApp

idstring

channelId a usar en /v1/whatsapp/{channelId}/*.

titlestring

Nombre del canal/sitio.

typestring

Tipo de canal WhatsApp.

whatsappNumberstring

Teléfono de la línea WhatsApp.

isWhatsAppChatboolean

Indica si el canal tiene chat de WhatsApp habilitado.

provider'gupshup' | 'meta_cloud' | 'null' nullable

Proveedor HSM derivado del canal (null si no tiene proveedor HSM).

hsmLineStatus'active' | 'error' | 'null' nullable

Estado de la línea: active (lista para enviar), null (sin línea dada de alta), error (fallo transitorio). Solo enviar HSM cuando es active.

Example response

[
  {
    "id": "5f9a1b2c3d4e5f6a7b8c9d0e",
    "title": "Mi Sitio",
    "type": "WHATSAPP_API",
    "whatsappNumber": "5491122788343"
  }
]