Skill de IA para API de WhatsAppMás
1msg official logo

Solicitar carga de documentos por WhatsApp API

El escenario envía al cliente una plantilla de WhatsApp personalizada cuando falta un documento requerido y debe cargarlo para continuar.

Descripción del caso de uso

El escenario envía al cliente una plantilla de WhatsApp personalizada cuando falta un documento requerido y debe cargarlo para continuar. El mensaje incluye el nombre del cliente, el tipo de documento e instrucciones de carga. Un botón URL estático abre el portal de carga de documentos o formulario seguro.

Ejemplo de plantilla

Hola, {{1}}! Por favor sube tu {{2}}. {{3}} Toca el botón de abajo para cargar tu documento. Si tienes preguntas — estamos para ayudarte.

Cargar documento
  • {{1}}
    nombre del cliente
  • {{2}}
    documento a cargar (p. ej. escaneo de pasaporte, comprobante de domicilio, estado de ingresos)
  • {{3}}
    instrucciones de carga (p. ej. formato PDF o foto, subir antes del viernes)
  • “Cargar documento”
    botón — fijo en la plantilla de Meta
WhatsApp Business API for document upload request

Cuándo usarlo

Usa este escenario cuando un cliente debe cargar un documento requerido para continuar onboarding, completar una solicitud de soporte o desbloquear funciones de cuenta — y aún no lo ha enviado, sin conversación abierta en WhatsApp para contactarlo en sesión. Encaja en equipos de producto que condicionan activación de cuenta a archivos KYC faltantes, mesas de soporte que esperan adjuntos o formularios firmados, y agencias que conectan compuertas de documentos de CRM o BPM a empujones de carga en WhatsApp.

Documentos faltantes recogidos sin persecución por correo
Tres variables del cuerpo llevan el nombre del cliente, el tipo de documento y las instrucciones de carga, así la solicitud explica exactamente qué enviar en lugar de un aviso genérico de "completa tu perfil".
Portal de carga a un toque
Un botón URL estático con la etiqueta Cargar documento abre el portal o formulario seguro de carga — el enlace está fijado en la plantilla aprobada de Meta y solo el texto del cuerpo se envía vía API.
Contactar clientes fuera de la ventana de 24 horas
Como no hay conversación activa, el envío usa una plantilla de WhatsApp aprobada vía la API de 1MSG — el único canal que puede pedir carga de documento cuando el cliente no ha escrito primero.
Cero seguimiento manual por cada archivo faltante
Cuando dispara un evento de carga de documento requerida desde onboarding, soporte o cumplimiento, el sistema obtiene el teléfono y envía la plantilla con ese evento en lugar de que alguien copie instrucciones de carga a mano.
Entrega registrada para seguimiento del flujo
El resultado de entrega se registra tras el envío, así CRM o equipos de soporte ven a quién se pidió cargar y manejan errores según las reglas de la plataforma.

Flujo de trabajo

  1. Disparador

    Una regla de negocio o flujo de trabajo exige que el cliente cargue un documento específico.

    evento · disparado

  2. Capturar evento

    El sistema detecta el evento de carga de documento requerida y obtiene el teléfono del destinatario.

    phone: "+…"

  3. Construir y enviar

    Se construye un mensaje de plantilla personalizado con tres variables en el cuerpo y un botón URL estático.

    POST /sendTemplate

  4. Entregado

    El cliente recibe la solicitud de carga de documento en WhatsApp con contexto del documento e instrucciones.

    entregado

  5. Estado registrado

    Se registra el resultado de entrega; el cliente puede cargar vía el enlace del portal.

    status: "read"

WhatsApp Business API for document upload request

Implementación técnica

Requisitos previos

  1. Clave API de 1MSG · Cómo obtener la clave API
  2. Cuenta de WhatsApp Business · Cómo conectar WABA
  3. Plantilla de WhatsApp · Cómo aprobar una plantilla WABA
  4. Opt-in del cliente · Cómo gestionar el consentimiento

Ejemplos de código

#!/usr/bin/env bash
set -euo pipefail

# === Configuration (replace "___" placeholders) ===

API_BASE_URL="https://api.1msg.io"        # production 1MSG API base URL
CHANNEL_ID="___"                           # channel ID from 1MSG dashboard
API_TOKEN="___"                            # channel JWT token (Bearer)

TEMPLATE_NAME="___"                        # approved template name
TEMPLATE_NAMESPACE="___"                   # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___"                    # template language code, e.g. "en"



# === Test data ===
TEST_PHONE="___"                 # client phone in international format
TEST_CUSTOMERNAME="___"         # {{1}} customer name
TEST_AWAITEDITEM="___"         # {{2}} awaited item
TEST_REQUESTDETAIL="___"         # {{3}} request detail

PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"

for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
            "TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
            "TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
            "TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
            "TEST_AWAITEDITEM=$TEST_AWAITEDITEM" \
            "TEST_REQUESTDETAIL=$TEST_REQUESTDETAIL"; do
    val="${pair#*=}"
    if [ -z "$val" ] || [ "$val" = "___" ]; then
        echo "Missing configuration value: ${pair%%=*}" >&2
        exit 1
    fi
done

if [ -z "$PHONE_NORM" ]; then
    echo "Error: phone number has no digits after normalization" >&2
    exit 1
fi

URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"

# params carries body ONLY. Button text is fixed in the Meta template — no button param.

# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} awaited item → ${TEST_AWAITEDITEM}
# {{3}} request detail → ${TEST_REQUESTDETAIL}
read -r -d '' PAYLOAD <<JSON || true
{
  "phone": "${PHONE_NORM}",
  "template": "${TEMPLATE_NAME}",
  "namespace": "${TEMPLATE_NAMESPACE}",
  "language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
  "params": [
    {
      "type": "body",
      "parameters": [
        { "type": "text", "text": "${TEST_CUSTOMERNAME}" },
        { "type": "text", "text": "${TEST_AWAITEDITEM}" },
        { "type": "text", "text": "${TEST_REQUESTDETAIL}" }
      ]
    }

  ]
}
JSON

RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${API_TOKEN}" \
    -d "$PAYLOAD")"

HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"

case "$BODY" in
    *'"sent":true'*) ok=1 ;;
    *) ok=0 ;;
esac

if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
    echo "Message sent to client."
    echo "API response: $BODY"
else
    echo "Send failed. HTTP status: $HTTP_CODE" >&2
    echo "$BODY" >&2
    exit 1
fi

Respuesta y estado de entrega

HTTP 2xx y JSON "sent": true significan que 1MSG aceptó el mensaje para envío — no que ya llegó al teléfono del cliente. Guarda el campo id (tipo wamid.…) para correlacionar los callbacks de entrega.

200 OKRespuesta
{
  "sent": true,
  "message": "Sent to [email protected]",
  "description": "Message has been sent to the provider",
  "id": "wamid.HBgLMzgwNjM5..."
}
  • sent

    Aceptado para envío — aún no en el teléfono del cliente

  • id

    Guárdalo; los callbacks de entrega y hookInfo se basan en él

Estados de entrega y webhooks →

Errores frecuentes

EstadoRespuesta de la APICausaSolución
200Message was not sent: template is not definedFalta namespace, template o language en el cuerpo de la petición.Envía los tres. Toma namespace y el nombre exacto de la plantilla de GET /templates; language es un objeto: {"policy": "deterministic", "code": "es_MX"}.
200template name (…) does not exist in <language>La plantilla está aprobada en otro idioma que el solicitado.Usa el código de idioma exacto con el que se aprobó la plantilla (por ejemplo, es_MX no es lo mismo que es). Revísalo en GET /templates.
200Message was not sent: provide chatId, phone, bsuid, or usernameNingún destinatario que el canal pudiera resolver.Envía un solo destinatario: phone (código de país y número, solo dígitos), chatId (por ejemplo [email protected]) o bsuid.

Todos los códigos de error →

Preguntas comunes

Relacionado

Atención al cliente
Solicitud de firma electrónica con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando debe firmar un documento o confirmar datos enviados para continuar.
Atención al cliente
Aviso de KYC rechazado con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando su eKYC o verificación de identidad es rechazada.
Atención al cliente
Aviso de KYC aprobado con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando su verificación de identidad o eKYC es aprobada.
Atención al cliente
Estado de verificación KYC con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando cambia el estado de su verificación o eKYC.
Atención al cliente
Aviso de transferencia de ticket con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando un ticket de soporte se transfiere a otro departamento.
Atención al cliente
Notificación de estado del ticket con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando cambia el estado de un ticket de soporte.
Atención al cliente
Aviso de escalamiento de ticket con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando un ticket de soporte se escala porque la resolución tarda más de lo habitual.
Atención al cliente
Aviso de ticket creado con WhatsApp API
El escenario envía al cliente una plantilla de WhatsApp personalizada cuando se crea un nuevo ticket de soporte.

Desarrolla para WhatsApp en horas
sin complicaciones de infraestructura