Cupones y ofertas por tiempo limitado

Last update: 4 days ago by Irais Aguirre

Resumen para integración
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
Token: de mensajería, en el encabezado Authorization: Bearer {{wa-msg-api-token}} (cómo generarlo)
Campos comunes: from, to (teléfono o BSUID) y type (detalle)
Valores de type en esta página: "template"
Respuesta: la misma para todos los mensajes (ver respuesta)

Plantillas con códigos de cupón y ofertas por tiempo limitado. Todos se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP. La estructura general de la plantilla (objetos template y components) está en Mensajes con plantilla.

Cupones

Botón para copiar un código de cupón: componente button con subtype "copy_code". En el objeto del parámetro, type debe ser "coupon_code".

Cuerpo

Campos de Cupones:

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "button".	String	Obligatorio
subtype	El valor es “copy_code”.	String	Obligatorio
index	Orden en el que el botón aparece en la parte inferior del mensaje de plantilla. Se expresa como un índice que comienza en 0, es decir que 0 indica el primer botón; 1, el segundo, etc.	Integer	Obligatorio
parameters		Lista objetos	Obligatorio

Objeto parameters

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "coupon_code".	String	Obligatorio
coupon_code	El código del cupón que se copiará cuando el cliente toque el botón.	String	Obligatorio

Ejemplo

Ejemplo completo de Cupones (petición HTTP y cuerpo JSON):

Petición HTTP cupones

curl --location --request POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
  "from": "5215541697885",
  "to": "5614782109",
  "type": "template",
  "template": {
    "language": "en",
    "name": "concepto_movil_cupones_products",
    "components": [
   
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "25OFF"
          },
          {
            "type": "text",
            "text": "25%"
          }
        ]
      },
      {
        "type": "button",
        "subtype": "copy_code",
        "index": 1,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "25OFF"
          }
        ]
      }
    ]
  }
}'

Body cupones


{
  "from": "5215541697885",
  "to": "5614782109",
  "type": "template",
  "template": {
    "language": "en",
    "name": "concepto_movil_cupones_products",
    "components": [
   
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "25OFF"
          },
          {
            "type": "text",
            "text": "25%"
          }
        ]
      },
      {
        "type": "button",
        "subtype": "copy_code",
        "index": 1,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "25OFF"
          }
        ]
      }
    ]
  }
}

Oferta por tiempo limitado

Permite mostrar fechas de caducidad y temporizadores de cuenta regresiva para códigos de oferta. Se envía como un componente limited_time_offer, normalmente junto con un botón "copy_code".

Cuerpo

Campos de Oferta por tiempo limitado:

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “limited_time_offer”.	String	Obligatorio
limited_time_offer	Objeto en donde se especificará la fecha de expiración de la oferta.	Object	Obligatorio

Objeto limited_time_offer

Nombre	Descripción	Tipo	Requerimientos
expiration_date_time	Define la fecha y hora exactas en que la oferta expira, después de la cual no estará disponible. Este campo debe seguir el formato "YYYY-MM-DD HH:mm". Se interpreta en la zona horaria del servidor. Un formato inválido devuelve el error 1009.	String	Obligatorio

Ejemplo

Ejemplo completo de Oferta por tiempo limitado (petición HTTP y cuerpo JSON):

Petición HTTP oferta por tiempo limitado

curl --location --request POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
  "from": "5215541697885",
  "to": "5614782109",
  "type": "template",
  "template": {
    "language": "en",
    "name": "concepto_movil_olt_products",
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "link": "https://upload.wikimedia.org/wikipedia/commons/thumb/6/6b/WhatsApp.svg/1200px-WhatsApp.svg.png",
            "type": "image"
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          },
          {
            "type": "text",
            "text": "CARIBE25"
          }
        ]
      },
      {
        "type": "limited_time_offer",
        "parameters": [
          {
            "type": "limited_time_offer",
            "limited_time_offer": {
              "expiration_date_time": "2024-12-04 15:20"
            }
          }
        ]
      },
      {
        "type": "button",
        "subtype": "copy_code",
        "index": 0,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "CARIBE25"
          }
        ]
      },
      {
        "type": "button",
        "subtype": "url",
        "index": 1,
        "parameters": [
          {
            "type": "text",
            "text": "n3mtql"
          }
        ]
      }
    ]
  }
}'

Body oferta por tiempo limitado

{
  "from": "5215541697885",
  "to": "5614782109",
  "type": "template",
  "template": {
    "language": "en",
    "name": "concepto_movil_olt_products",
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "link": "https://upload.wikimedia.org/wikipedia/commons/thumb/6/6b/WhatsApp.svg/1200px-WhatsApp.svg.png",
            "type": "image"
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          },
          {
            "type": "text",
            "text": "CARIBE25"
          }
        ]
      },
      {
        "type": "limited_time_offer",
        "parameters": [
          {
            "type": "limited_time_offer",
            "limited_time_offer": {
              "expiration_date_time": "2024-12-04 15:20"
            }
          }
        ]
      },
      {
        "type": "button",
        "subtype": "copy_code",
        "index": 0,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "CARIBE25"
          }
        ]
      },
      {
        "type": "button",
        "subtype": "url",
        "index": 1,
        "parameters": [
          {
            "type": "text",
            "text": "n3mtql"
          }
        ]
      }
    ]
  }
}

Secuencia

Mensajes interactivos