Enviar plantillas de mensajes multimedia
Las plantillas de mensajes multimedia amplían el contenido que puedes enviar a los destinatarios más allá del tipo de plantilla de mensaje estándar, lo que permite incluir contenido multimedia y encabezados usando un objeto components. El objeto components te permite indicar el type de mensaje y los parameters del mensaje.
 |  |  |
Paso 1: Haz una solicitud POST a /messages
POST /v1/messages
{
"to": "recipient_wa_id",
"type": "template",
"template": {
"namespace": "your-namespace",
"language": {
"policy": "deterministic",
"code": "your-language-and-locale-code"
},
"name": "your-template-name",
"components": [
{
"type" : "header",
"parameters": [
# The following parameters code example includes several different possible header types,
# not all are required for a media message template API call.
{
"type": "text",
"text": "replacement_text"
}
# OR
{
"type": "document",
"document": {
"id": "your-media-id",
# filename is an optional parameter
"filename": "your-document-filename"
}
}
# OR
{
"type": "document",
"document": {
"link": "the-provider-name/protocol://the-url",
# provider and filename are optional parameters
"provider": {
"name" : "provider-name"
},
"filename": "your-document-filename"
}
}
# OR
{
"type": "video",
"video": {
"id": "your-media-id"
}
}
# OR
{
"type": "video",
"video": {
"link": "the-provider-name/protocol://the-url"
# provider is an optional parameter
"provider": {
"name" : "provider-name"
}
}
}
# OR
{
"type": "image",
"image": {
"link": "http(s)://the-url",
# provider is an optional parameter
"provider": {
"name" : "provider-name"
},
}
}
]
# end header
},
{
"type" : "body",
"parameters": [
{
"type": "text",
"text": "replacement_text"
},
{
"type": "currency",
"currency" : {
"fallback_value": "$100.99",
"code": "USD",
"amount_1000": 100990
}
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "February 25, 1977",
"day_of_week": 5,
"day_of_month": 25,
"year": 1977,
"month": 2,
"hour": 15,
"minute": 33, #OR
"timestamp": 1485470276
}
},
{
...
# Any additional template parameters
}
]
# end body
},
]
}
}
Parámetros
Recomendación sobre el formato del contenido multimedia
- Las imágenes con una relación de aspecto superior a 1.91:1 se recortan de forma vertical. Para comunicar el punto central de este tipo de imágenes, presenta la información más importante en el centro.
Paso 2: Verifica la respuesta de la API
Una respuesta correcta incluye un objeto messages con un valor de id.
{
"messages": [{
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
}]
}
Una respuesta errónea contiene un objeto incorrecto con una cadena incorrecta, un código de error e información adicional.
Si se envía una plantilla a una cuenta que no puede recibirla, se enviará el error 1026 (ReceiverIncapable) en el objeto de error al servidor del webhook configurado.
Para obtener más información sobre errores, consulta Códigos de error y de estado.
Ejemplos
Estos ejemplos demuestran el proceso de configuración de plantillas de mensajes multimedia a partir de la creación de plantillas en el administrador comercial y el envío de plantillas de mensajes con llamadas a la API al extremo messages.
Estos ejemplos se proporcionan solo para fines ilustrativos y no se pueden utilizar. Debes crear tus propios ejemplos y obtener la aprobación para poder probar la funcionalidad de las plantillas de mensajes multimedia.
Ejemplo de entrada de película
Este ejemplo muestra la creación de una plantilla de mensajes multimedia con una imagen de código QR.
1. Crea la plantilla de mensajes multimedia en el administrador comercial.
2. La llamada a la API messages se agrega en la información de parámetros.
POST /v1/messages
{
"to": "your-test-recipient-wa-id",
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "movie_ticket_update",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"id": "your-image-id"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Star Rangers"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "May 1st, 2019 8:45pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 20,
"minute": 45
}
},
{
"type": "text",
"text": "Carnival, Sangam"
},
{
"type": "text",
"text": "Silver"
},
{
"type": "text",
"text": "F6, F7, F8"
}
]
}
]
}
}
3. El cliente recibe su mensaje de entrada de película.
Ejemplo de boleto de avión
Este ejemplo muestra la creación de una plantilla de mensajes multimedia con un documento PDF.
1. Crea la plantilla de mensajes multimedia en el administrador comercial.
2. La llamada a la API messages se agrega en la información de parámetros.
POST /v1/messages
{
"to": "your-test-recipient-wa-id",
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "flight_confirmation",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "document",
"document": {
"filename": "MRRATH-CGK-KUL.pdf",
"link": "link-to-your-document"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "CGK (Jakarta)"
},
{
"type": "text",
"text": "KUL (Kuala Lumpur)"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "20th April 2019, 12:20pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 12,
"minute": 10
}
}
]
}
]
}
}
3. El cliente recibe su tarjeta de embarque en un documento PDF.
