Saltar al contenido
ComdigDocs

Referencia de la API

Consultar un lote

Devuelve el estado y el avance de un lote de envío masivo. Solo consulta lotes de la empresa del token.

Solicitud#

GEThttps://api.comdig.co/v1/api-batch-status

Permiso requerido: templates:send o bulk:send

Parámetros de consulta#

  • batch_idstring (uuid)Requerido

    Identificador que devolvió Envío masivo.

Ejemplo#

Consultar un lote
curl -X GET "https://api.comdig.co/v1/api-batch-status?batch_id=5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d" \
  -H "X-API-Key: $COMDIG_API_KEY"

Respuestas#

  • 200Estado

    JSON
    {
      "batch_id": "uuid",
      "status": "processing",
      "template_name": "bienvenida",
      "total": 10,
      "sent": 4,
      "failed": 1,
      "pending": 5,
      "created_at": "2026-11-20T15:00:00Z",
      "started_at": "2026-11-20T15:00:02Z",
      "completed_at": null,
      "error_message": null
    }
  • 400Solicitud inválida · invalid_request

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/invalid_request",
      "title": "Solicitud inválida",
      "status": 400,
      "detail": "…",
      "code": "invalid_request"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · invalid_api_key

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/invalid_api_key",
      "title": "Token ausente o inválido",
      "status": 401,
      "detail": "…",
      "code": "invalid_api_key"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · api_key_expired

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/api_key_expired",
      "title": "Token vencido",
      "status": 401,
      "detail": "…",
      "code": "api_key_expired"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · missing_permission

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/missing_permission",
      "title": "El token no tiene el permiso",
      "status": 401,
      "detail": "…",
      "code": "missing_permission"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · token_creator_inactive

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/token_creator_inactive",
      "title": "Quien creó el token ya no es administrador activo",
      "status": 401,
      "detail": "…",
      "code": "token_creator_inactive"
    }
  • 404No encontrado · batch_not_found

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/batch_not_found",
      "title": "Lote no encontrado",
      "status": 404,
      "detail": "…",
      "code": "batch_not_found"
    }
  • 429Límite excedido (rate_limited, o too_many_active_batches en api-send-bulk)

    JSON
    {
      "error": "Demasiadas peticiones: máximo 10 por segundo por token. Reintenta tras Retry-After.",
      "type": "https://docs.comdig.co/errores/rate_limited",
      "title": "Demasiadas peticiones",
      "status": 429,
      "detail": "Demasiadas peticiones: máximo 10 por segundo por token. Reintenta tras Retry-After.",
      "code": "rate_limited"
    }

Errores#

Además del código HTTP, cada error trae el campo code. Programa tu integración contra él.

Estados del lote#

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