Listar Plantillas

curl -X POST https://beta.api-iobot-desarrollo.com/chats/obtener/mensaje/plantilla \
  -H "Content-Type: application/json" \
  -H "x-api-key: TU_APP_KEY" \
  -d '{
    "empresa_id": 1,
    "usuario_id": 42
  }'

{
  "plantillas": [
    {
      "id": 7,
      "nombre": "Bienvenida nuevo cliente",
      "id_plantilla": "bienvenida_nuevo_cliente",
      "descripcion": "Hola, gracias por escribirnos. Un asesor te atenderá pronto.",
      "codigo": null,
      "archivo_nombre": null,
      "type": "TEXT",
      "agentes_permitidos": null,
      "empresa_id": 1,
      "id_gupshup": null,
      "tipo": "Cloud",
      "botones": null,
      "articles": null,
      "visible": true,
      "template": {
        "name": "bienvenida_nuevo_cliente",
        "language": "es",
        "category": "MARKETING",
        "components": [
          {
            "type": "BODY",
            "text": "Hola, gracias por escribirnos. Un asesor te atenderá pronto."
          }
        ]
      },
      "version": null,
      "deleted_at": null,
      "contacto_variables": null,
      "created_by_ai": false,
      "created_at": "2025-03-11T15:02:44.000Z",
      "updated_at": "2025-03-11T15:02:44.000Z",
      "state": "APPROVED"
    },
    {
      "id": 12,
      "nombre": "Seguimiento de cotización",
      "id_plantilla": "seguimiento_cotizacion",
      "descripcion": "Hola {{1}}, tu cotización {{2}} sigue disponible por 48 horas.",
      "codigo": null,
      "archivo_nombre": null,
      "type": "TEXT",
      "agentes_permitidos": "42,55",
      "empresa_id": 1,
      "id_gupshup": null,
      "tipo": "Cloud",
      "botones": null,
      "articles": null,
      "visible": true,
      "template": {
        "name": "seguimiento_cotizacion",
        "language": "es",
        "category": "MARKETING",
        "components": [
          {
            "type": "BODY",
            "text": "Hola {{1}}, tu cotización {{2}} sigue disponible por 48 horas.",
            "example": {
              "body_text": [["Juan Pérez", "COT-9982"]]
            }
          }
        ]
      },
      "version": null,
      "deleted_at": null,
      "contacto_variables": null,
      "created_by_ai": false,
      "created_at": "2025-04-02T09:20:10.000Z",
      "updated_at": "2025-04-02T09:20:10.000Z",
      "state": "APPROVED"
    }
  ]
}

"Error: Could not connect to Meta API"

POST

chats

obtener

mensaje

plantilla

curl -X POST https://beta.api-iobot-desarrollo.com/chats/obtener/mensaje/plantilla \
  -H "Content-Type: application/json" \
  -H "x-api-key: TU_APP_KEY" \
  -d '{
    "empresa_id": 1,
    "usuario_id": 42
  }'

{
  "plantillas": [
    {
      "id": 7,
      "nombre": "Bienvenida nuevo cliente",
      "id_plantilla": "bienvenida_nuevo_cliente",
      "descripcion": "Hola, gracias por escribirnos. Un asesor te atenderá pronto.",
      "codigo": null,
      "archivo_nombre": null,
      "type": "TEXT",
      "agentes_permitidos": null,
      "empresa_id": 1,
      "id_gupshup": null,
      "tipo": "Cloud",
      "botones": null,
      "articles": null,
      "visible": true,
      "template": {
        "name": "bienvenida_nuevo_cliente",
        "language": "es",
        "category": "MARKETING",
        "components": [
          {
            "type": "BODY",
            "text": "Hola, gracias por escribirnos. Un asesor te atenderá pronto."
          }
        ]
      },
      "version": null,
      "deleted_at": null,
      "contacto_variables": null,
      "created_by_ai": false,
      "created_at": "2025-03-11T15:02:44.000Z",
      "updated_at": "2025-03-11T15:02:44.000Z",
      "state": "APPROVED"
    },
    {
      "id": 12,
      "nombre": "Seguimiento de cotización",
      "id_plantilla": "seguimiento_cotizacion",
      "descripcion": "Hola {{1}}, tu cotización {{2}} sigue disponible por 48 horas.",
      "codigo": null,
      "archivo_nombre": null,
      "type": "TEXT",
      "agentes_permitidos": "42,55",
      "empresa_id": 1,
      "id_gupshup": null,
      "tipo": "Cloud",
      "botones": null,
      "articles": null,
      "visible": true,
      "template": {
        "name": "seguimiento_cotizacion",
        "language": "es",
        "category": "MARKETING",
        "components": [
          {
            "type": "BODY",
            "text": "Hola {{1}}, tu cotización {{2}} sigue disponible por 48 horas.",
            "example": {
              "body_text": [["Juan Pérez", "COT-9982"]]
            }
          }
        ]
      },
      "version": null,
      "deleted_at": null,
      "contacto_variables": null,
      "created_by_ai": false,
      "created_at": "2025-04-02T09:20:10.000Z",
      "updated_at": "2025-04-02T09:20:10.000Z",
      "state": "APPROVED"
    }
  ]
}

"Error: Could not connect to Meta API"

Retorna todas las plantillas de WhatsApp activas y visibles de una empresa. Cada plantilla incluye su id interno — el valor que necesitas para enviarla — junto con su estructura completa (template, descripcion, botones), que te permite saber cuántos parámetros exige antes de enviarla. El estado de aprobación (state) se resuelve en tiempo real contra la API de Meta, cruzando id_plantilla con el nombre de la plantilla registrada en el WABA de la empresa.

Autenticación

Requiere el encabezado x-api-key con el App Key del negocio. Consulta Autenticación.

Encabezados

string

required

App Key del negocio. Consulta Autenticación.

Cuerpo de la solicitud

number

required

ID del negocio cuyas plantillas deseas obtener.

number

required

ID del usuario en cuyo nombre se consulta. Debe pertenecer a empresa_id.

Si usuario_id no corresponde a un usuario de empresa_id, la solicitud falla con 500. Verifica el ID antes de llamar.

Filtros aplicados

Siempre se excluyen las plantillas que cumplan alguna de estas condiciones:

Condición	Efecto
`visible: false`	La plantilla está oculta y no se devuelve
`deleted_at` distinto de `null`	Eliminación suave: no se devuelve
Rol agente sin ID en `agentes_permitidos`	No se devuelve para ese usuario

Respuesta

array

Lista de plantillas disponibles.

Show Objeto de plantilla

number

ID interno de la plantilla. Es el valor que se envía como plantilla_id en Enviar Plantilla.

string

Nombre legible de la plantilla, tal como se muestra en el panel.

string

Nombre de la plantilla registrado en Meta. Se usa para cruzar el estado de aprobación.

string

Texto del cuerpo de la plantilla. Contiene los marcadores de posición ({{1}}, {{2}}, …) que se sustituyen con parameters al enviar.

object | null

Estructura completa de la plantilla en formato Meta, con el arreglo components (HEADER, BODY, FOOTER, BUTTONS). Es la fuente autoritativa para determinar cuántos parámetros requiere la plantilla.

string | null

Configuración de botones asociada a la plantilla.

string | null

Código interno opcional de la plantilla.

string | null

Nombre del archivo multimedia adjunto en el encabezado, si la plantilla tiene uno.

string | null

Tipo de contenido del encabezado (por ejemplo TEXT, IMAGE, DOCUMENT, VIDEO).

string

Proveedor de la plantilla. Valores posibles: Cloud (WhatsApp Cloud API) o GupShup.

string | null

IDs de agentes separados por coma que pueden usar esta plantilla. Vacío o null significa que no está restringida por agente.

number[] | null

Índices de parámetros que se autocompletan con datos del contacto en lugar de valores manuales.

string | null

Artículos de catálogo asociados a la plantilla.

number

Negocio al que pertenece la plantilla.

string | null

Identificador en GupShup cuando tipo es GupShup.

string | null

Versión de la plantilla.

boolean

Siempre true en esta respuesta: las plantillas ocultas se filtran.

string | null

Siempre null en esta respuesta: las eliminadas se filtran.

boolean

Indica si la plantilla fue generada con asistencia de IA. Se resuelve por la bandera almacenada o, para plantillas antiguas, por el prefijo osm_ en el nombre.

string

Estado de aprobación en Meta: APPROVED, PENDING, REJECTED, o no_status si la plantilla no se encontró en el WABA.

string

Fecha de creación.

string

Fecha de última actualización.

Cómo saber cuántos parámetros requiere una plantilla

Antes de enviar, determina el número de valores que debes pasar en parameters. La resolución sigue este orden de precedencia:

Componente BODY del campo template

Busca en template.components el elemento con type: "BODY" y cuenta el marcador {{n}} más alto de su text. Si text no tiene marcadores, usa la longitud de example.body_text[0] o de example.body_text_named_params.

Marcadores en descripcion

Si template es null o no tiene componente BODY, cuenta el {{n}} más alto en descripcion.

Sin parámetros

Si no se encuentra ningún marcador, la plantilla no requiere parámetros y debes enviar parameters: [].

Solo se cuentan los parámetros del cuerpo (BODY). Los parámetros de encabezado y de botones no se envían con este flujo.

Ejemplo: si descripcion es "Hola {{1}}, tu pedido {{2}} ya salió", la plantilla requiere 2 parámetros y se envía parameters: ["Juan", "#9982"].

curl -X POST https://beta.api-iobot-desarrollo.com/chats/obtener/mensaje/plantilla \
  -H "Content-Type: application/json" \
  -H "x-api-key: TU_APP_KEY" \
  -d '{
    "empresa_id": 1,
    "usuario_id": 42
  }'

{
  "plantillas": [
    {
      "id": 7,
      "nombre": "Bienvenida nuevo cliente",
      "id_plantilla": "bienvenida_nuevo_cliente",
      "descripcion": "Hola, gracias por escribirnos. Un asesor te atenderá pronto.",
      "codigo": null,
      "archivo_nombre": null,
      "type": "TEXT",
      "agentes_permitidos": null,
      "empresa_id": 1,
      "id_gupshup": null,
      "tipo": "Cloud",
      "botones": null,
      "articles": null,
      "visible": true,
      "template": {
        "name": "bienvenida_nuevo_cliente",
        "language": "es",
        "category": "MARKETING",
        "components": [
          {
            "type": "BODY",
            "text": "Hola, gracias por escribirnos. Un asesor te atenderá pronto."
          }
        ]
      },
      "version": null,
      "deleted_at": null,
      "contacto_variables": null,
      "created_by_ai": false,
      "created_at": "2025-03-11T15:02:44.000Z",
      "updated_at": "2025-03-11T15:02:44.000Z",
      "state": "APPROVED"
    },
    {
      "id": 12,
      "nombre": "Seguimiento de cotización",
      "id_plantilla": "seguimiento_cotizacion",
      "descripcion": "Hola {{1}}, tu cotización {{2}} sigue disponible por 48 horas.",
      "codigo": null,
      "archivo_nombre": null,
      "type": "TEXT",
      "agentes_permitidos": "42,55",
      "empresa_id": 1,
      "id_gupshup": null,
      "tipo": "Cloud",
      "botones": null,
      "articles": null,
      "visible": true,
      "template": {
        "name": "seguimiento_cotizacion",
        "language": "es",
        "category": "MARKETING",
        "components": [
          {
            "type": "BODY",
            "text": "Hola {{1}}, tu cotización {{2}} sigue disponible por 48 horas.",
            "example": {
              "body_text": [["Juan Pérez", "COT-9982"]]
            }
          }
        ]
      },
      "version": null,
      "deleted_at": null,
      "contacto_variables": null,
      "created_by_ai": false,
      "created_at": "2025-04-02T09:20:10.000Z",
      "updated_at": "2025-04-02T09:20:10.000Z",
      "state": "APPROVED"
    }
  ]
}

"Error: Could not connect to Meta API"

En caso de error este endpoint devuelve un string JSON plano, no un objeto. Considéralo al parsear la respuesta.

Plantillas de Mensajes

Chats

Campañas

Reporte Compartido

Ordenes

Autenticación

Encabezados

Cuerpo de la solicitud

Filtros aplicados

Respuesta

Cómo saber cuántos parámetros requiere una plantilla

​Autenticación

​Encabezados

​Cuerpo de la solicitud

​Filtros aplicados

​Respuesta

​Cómo saber cuántos parámetros requiere una plantilla

Autenticación

Encabezados

Cuerpo de la solicitud

Filtros aplicados

Respuesta

Cómo saber cuántos parámetros requiere una plantilla