Enviar Campaña

Envía una campaña a través de un canal activo del workspace. Puede usar la plantilla ya guardada en la campaña o una plantilla indicada explícitamente en el request.

POST https://api.platica.mx/v1/campaigns/{campaignId}/send

Parámetros de la URL

Parámetro	Tipo	Descripción	Requerimiento
`campaignId`	string	Identificador único de la campaña	obligatorio

Ejemplos de request

Envío inmediato usando la plantilla guardada en la campaña

{
  "channelId": "5215512345678",
  "template": {
    "params": ["Juan", "20% de descuento"],
    "sendToProblematic": false,
    "sendToUndeliverable": false
  }
}

Envío inmediato con una plantilla específica

{
  "channelId": "5215512345678",
  "template": {
    "name": "promo_verano_2026",
    "params": ["Juan", "20% de descuento"],
    "sendToProblematic": false,
    "sendToUndeliverable": false
  }
}

Envío con imagen y fechas programadas

{
  "channelId": "5215512345678",
  "template": {
    "name": "promo_verano_2026",
    "params": ["Juan"],
    "type": "image",
    "file": "https://example.com/promo.jpg",
    "scheduledDates": [
      "2026-07-01T10:00:00Z",
      "2026-07-08T10:00:00Z"
    ],
    "sendToProblematic": false,
    "sendToUndeliverable": false
  }
}

Envío con botones dinámicos

{
  "channelId": "5215512345678",
  "template": {
    "name": "promo_con_enlace",
    "params": ["Juan"],
    "buttons": [
      {
        "index": 0,
        "type": "button",
        "sub_type": "url",
        "text": "Ver oferta",
        "parameters": [
          { "type": "text", "text": "promo2026" }
        ]
      }
    ]
  }
}

Parámetros del cuerpo

Parámetro	Tipo	Descripción	Requerimiento
`channelId`	string	Canal EMISOR desde el que se envía la campaña (`prefixedChannelId`, ej. `wb-123`)	obligatorio
`responderAgentId`	string	Agente que RESPONDE las respuestas de la campaña, desacoplado del canal. Si se omite, se usa el `defaultAgentId` del canal	opcional
`template`	object	Configuración del template para el envío	obligatorio

Objeto `template`

Parámetro	Tipo	Descripción	Requerimiento
`name`	string	Nombre del template a usar. Si se omite, se usa el template configurado en la campaña	opcional
`params`	string[]	Valores para los parámetros variables del template, en orden	opcional
`type`	string	Tipo de media adjunto: `"image"`, `"video"` o `"document"`	opcional
`file`	string	URL `http(s)` del archivo a adjuntar. Es obligatorio cuando la plantilla requiere media	opcional
`buttons`	array	Parámetros dinámicos para los botones del template	opcional
`scheduledDates`	string[]	Fechas de envío programadas en formato ISO 8601. Deben ser fechas futuras	opcional
`sendToProblematic`	boolean	Si se debe enviar a contactos con número problemático	opcional (default `false`)
`sendToUndeliverable`	boolean	Si se debe enviar a contactos con entregas fallidas previas	opcional (default `false`)

Objeto `buttons[]`

Parámetro	Tipo	Descripción	Requerimiento
`index`	number	Índice del botón en el template (empieza en 0)	obligatorio
`type`	string	Tipo de componente. Si se omite, la API usa `"button"`	opcional
`sub_type`	string	Subtipo: `"url"`, `"phone_number"`, `"quick_reply"` u `"otp"`	opcional
`text`	string	Texto del botón. La API puede inferirlo desde la plantilla	opcional
`placeholder`	string	Placeholder o valor base definido en la plantilla para botones dinámicos	opcional
`parameters`	array	Parámetros dinámicos del botón	obligatorio

Objeto `buttons[].parameters[]`

Parámetro	Tipo	Descripción	Requerimiento
`type`	string	Tipo de parámetro del botón	obligatorio
`text`	string	Valor textual del parámetro	obligatorio
`url`	string	URL asociada al parámetro cuando aplica	opcional
`selectedFields`	string[]	Campos seleccionados para mapear contenido dinámico	opcional

Respuesta `200 OK`

{
  "status": "success",
  "message": "Campaign sent successfully",
  "data": {
    "status": "queued"
  }
}

data contiene la respuesta del servicio de envío aguas arriba, por lo que su estructura puede variar entre workspaces o integraciones.

Notas

channelId es el canal EMISOR. El agente que responde se controla con responderAgentId (desacoplado del canal): así puedes enviar desde un número y que responda un agente específico sin modificar el agente conectado a ese canal. Si no envías responderAgentId, responde el defaultAgentId del canal.
Si template.name se omite, se usa la plantilla guardada en la campaña. Si la campaña no tiene una plantilla configurada, el envío falla con 400.
El número de elementos en params debe coincidir exactamente con el número de variables esperado por la plantilla.
Si envías buttons, la cantidad de botones y sus índices deben existir en la plantilla validada.
Cuando la plantilla requiere media, file debe ser una URL válida http o https.
Todas las fechas de scheduledDates deben estar en el futuro al momento del request.

Anterior Eliminar Campaña Siguiente Obtener Audiencia