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
En esta página
Solicitud#
POSThttps://api.comdig.co/v1/api-send-bulk
Permiso requerido: templates:send o bulk:send
Parámetros del cuerpo#
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
template_name | string | Sí | Nombre de una plantilla aprobada. |
contacts | array<object> | Sí | Destinatarios del envío. |
contacts[].phone | string | Si no hay wa_user_id | Teléfono en formato E.164. |
contacts[].wa_user_id | string | No | ID de usuario de WhatsApp, en lugar de phone. |
contacts[].name | string | No | Nombre del contacto. |
contacts[].variables | array<string> | No | Variables del cuerpo para este contacto. |
contacts[].header_variables | array<string> | No | Variables del encabezado para este contacto. |
contacts[].header_media | object | No | Archivo del encabezado para este contacto. |
contacts[].buttons | array | No | Botones para este contacto. |
contacts[].badge_label | string | No | Insignia para este contacto. |
contacts[].badge_color | string | No | Color de la insignia para este contacto. |
contacts[].source_label | string | No | Origen para este contacto. |
header_image_url | string | No | Heredado. Imagen de encabezado global.Heredado |
header_media | object | No | Encabezado global: { type, url, filename? }. |
header_variables | array<string> | No | Variables de encabezado globales. |
buttons | array | No | Botones globales: { sub_type, index, parameter }. |
badge_label | string | No | Insignia global. |
badge_color | string | No | Color de insignia global.Valores: cyan | blue | purple | pink | slate | teal |
source_label | string | No | Origen global. |
Ejemplo#
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#
| Estado | Significado |
|---|---|
queued | En cola. |
processing | Enviándose. |
completed | Terminado. |
stopped | Detenido. |
failed | Falló. |