Saltar al contenido
ComdigDocs

Referencia de la API

Envío masivo

Envía una plantilla a muchos contactos. Se procesa en segundo plano y responde de inmediato con el identificador del lote. Los teléfonos repetidos se envían una sola vez. Los valores de cada contacto sobreescriben los valores globales.

POST/api-send-bulk

Solicitud#

POSThttps://api.comdig.co/v1/api-send-bulk

Permiso requerido: templates:send o bulk:send

Parámetros del cuerpo#

Parámetros del cuerpo
NombreTipoRequeridoDescripción
template_namestringSíNombre de una plantilla aprobada.
contactsarray<object>SíDestinatarios del envío.
contacts[].phonestringSi no hay wa_user_idTeléfono en formato E.164.
contacts[].wa_user_idstringNoID de usuario de WhatsApp, en lugar de phone.
contacts[].namestringNoNombre del contacto.
contacts[].variablesarray<string>NoVariables del cuerpo para este contacto.
contacts[].header_variablesarray<string>NoVariables del encabezado para este contacto.
contacts[].header_mediaobjectNoArchivo del encabezado para este contacto.
contacts[].buttonsarrayNoBotones para este contacto.
contacts[].badge_labelstringNoInsignia para este contacto.
contacts[].badge_colorstringNoColor de la insignia para este contacto.
contacts[].source_labelstringNoOrigen para este contacto.
header_image_urlstringNoHeredado. Imagen de encabezado global.Heredado
header_mediaobjectNoEncabezado global: { type, url, filename? }.
header_variablesarray<string>NoVariables de encabezado globales.
buttonsarrayNoBotones globales: { sub_type, index, parameter }.
badge_labelstringNoInsignia global.
badge_colorstringNoColor de insignia global.Valores: cyan | blue | purple | pink | slate | teal
source_labelstringNoOrigen global.

Ejemplo#

Envío a dos contactos
curl -X POST "https://api.comdig.co/v1/api-send-bulk" \
  -H "X-API-Key: $COMDIG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "template_name": "recordatorio_pago",
  "contacts": [
    {
      "phone": "+573001234567",
      "name": "Ana Gómez",
      "variables": [
        "Ana",
        "25 de noviembre"
      ]
    },
    {
      "phone": "+573109876543",
      "name": "Luis Pérez",
      "variables": [
        "Luis",
        "28 de noviembre"
      ]
    }
  ],
  "source_label": "Cobranza"
}'

Respuestas#

200Lote en cola. Estados posibles del lote: queued, processing, completed, stopped y failed.

JSON
{
  "success": true,
  "batch_id": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d",
  "total_contacts": 2,
  "status": "queued"
}

Estados del lote#

EstadoSignificado
queuedEn cola.
processingEnviándose.
completedTerminado.
stoppedDetenido.
failedFalló.