INBOUND
Ejemplo seleccionando mensaje a responder
Ejemplo de la petición
Content-Type: application/json
JSON petición:
{
"contacts":[
{
"profile":{
"name":"William G." },
"wa_id":"5731XXXXXXXX"}
],
"messages":[
{
"context":{
"from":"5732XXXXXXXX",
"id":"gBEGVzE3AEU1AgnP3gFWMWGEWDg",
"mentions":null,
"forwarded":false,
"frequently_forwarded":null},
"from":"5731XXXXXXXX",
"id":"ABEGVzE3AEU1AhB4Lf6k-JlKQ9PcG7VwSeeA",
"timestamp":"1636642802",
"type":"text",
"text":{
"body":"Hi" },
"audio":null,
"document":null,
"image":null,
"location":null,
"video":null,
"voice":null
}
],
"statuses":null,
"originNumber":"5732XXXXXXXX"
}
Ejemplo sin seleccionar mensaje a responder
Ejemplo de la petición
Content-Type: application/json
JSON petición:
{
"contacts":[
{
"profile":{
"name":"William G."
},
"wa_id":"5731XXXXXXXX"
}
],
"messages":[
{
"context":null,
"from":"5731XXXXXXXX",
"id":"ABEGVzE3AEU1AhCEEYWND0lyDPU4ScTnJ5LM",
"timestamp":"1636642936",
"type":"text",
"text":{
"body":"Sin seleccionar"
},
"audio":null,
"document":null,
"image":null,
"location":null,
"video":null,
"voice":null,
"contacts":null,
}
],
"statuses":null,
"origin_number":"5732XXXXXXXX"
}
Ejemplo respuesta con multimedia
Al recibir una respuesta con multimedia; dependiendo el tipo de multimedia (image, document, audio, video, voice) en el campo link de la multimedia está el enlace al archivo.
Ejemplo de la respuesta
Content-Type: application/json
JSON petición:
{
"contacts": [
{
"profile": {
"name": "William G."
},
"wa_id": "5731XXXXXXXX"
}
],
"messages": [
{
"context": null,
"from": "5731XXXXXXXX",
"id": "9f1064df-dc55-44cb-aa3b-81a0fda13f5e",
"timestamp": "1639224685",
"type": "image",
"text": null,
"audio": null,
"document": null,
"image": {
"file": null,
"id": "7b396b28-7667-4be3-851e-f295a46674d1",
"link": "https://docs.aldeamo.com/getFiles/7b396b28-7667-4be3-851ef295a46674d1GU10508T11117Rs50yPwhatsappmedia.jpg",
"sha256": "2dfb4521bf1d06d3eb5379bfed48e820eb96785e7d491409ff358bf38848e70d",
"caption": null,
"mime_type": "image/jpeg"
},
"location": null,
"video": {
"file": null,
"id": "7b396b28-7667-4be3-851e-f295a46674d1",
"link": "https://docs.aldeamo.com/getFiles/7b396b28-7667-4be3-851ef295a46674d1GU10508T11117Rs50yPwhatsappmedia.mp4",
"sha256": "2dfb4521bf1d06d3eb5379bfed48e820eb96785e7d491409ff358bf38848e70d",
"caption": null,
"mime_type": "video/mp4"
},
"voice": null
}
],
"statuses": null,
"origin_number": "5731XXXXXXX"
}Ejemplo respuesta con contactos
Al recibir una respuesta con contactos; dependiendo el tipo de multimedia (image, document, audio, video, voice) en el campo link de la multimedia está el enlace al archivo.
Ejemplo de la respuesta
Content-Type: application/json
JSON petición:
{
"contacts": [
{
"profile": {
"name": "William G."
},
"wa_id": "5731XXXXXXXX"
}
],
"messages": [
{
"context": null,
"from": "5731XXXXXXXX",
"id": "9f1064df-dc55-44cb-aa3b-81a0fda13f5e",
"timestamp": "1639224685",
"type": "image",
"text": null,
"audio": null,
"document": null,
"contacts": [
{
"addresses": [
{
"city": "Tumbaco-canton Quito",
"country": "Ecuador",
"country_code": "ec",
"street": "Pasaje Los Sauces Y \nTercera Transversal Edificio
Natura Oficina 205",
"type": "WORK",
"zip": 170999
}
],
"emails": [
{
"email": "test@gmail.com",
"type": "INTERNET"
}
],
"ims": [
{
"service": "",
"user_id": ""
}
],
"name": {
"first_name": "JETHANDLING",
"formatted_name": "JETHANDLING FBO Jethandling Ecuador SA",
"last_name": "FBO Jethandling Ecuador SA"
},
"org": {},
"phones": [
{
"phone":"0 2-230-039",
"type": "MAIN"
}
],
"urls": []
}
],
"voice": null
}
],
"statuses": null,
"origin_number": "5731XXXXXXXX"
}
Ejemplo respuesta con interacción
Content-Type: application/json
{
"contacts": [
{
"profile": {
"name": "William G."
},
"wa_id": "5731XXXXXXXX"
}
],
"messages": [
{
"context": {
"from": "5731XXXXXXXX",
"id": "e052f7d0-acd9-4c9c-b90c-80c2846daa44",
"mentions": null,
"forwarded": false,
"frequently_forwarded": null
},
"from": "5731XXXXXXXX",
"id": "ABEGVzE3AEU1Ago-sGZFyNWirb6O",
"timestamp": "1640019033",
"type": "interactive",
"text": null,
"audio": null,
"document": null,
"image": null,
"location": null,
"video": null,
"voice": null,
"sticker": null,
"contacts": null,
"interactive": {
"type": "list_reply/button_replay",
"button_reply": botton_reply,
"list_reply": {
"id": "<ID 1.1>",
"title": "<Title 1.1>",
"description": "<Description 1.1>"
},
"button_reply": {
"id": "<ID 1.1>",
"title": "<Title 1.1>"
}
}
}
],
"statuses": null,
"origin_number": "5731XXXXXXXX"
}Ejemplo respuesta a plantillas QuickReplay
{
"contacts": [
{
"profile": {
"name": "Nombre del contacto"
},
"wa_id": "573137XXXXXX"
}
],
"messages": [
{
"context": {
"from": "573137XXXXXX",
"id": "1f684155-a0e6-4854-8c8e-3271a1c2aa64",
"mentions": null,
"forwarded": false,
"frequently_forwarded": null
},
"from": "573137XXXXXX",
"id": "ABEGVzE3AEU1Ago-sBEA5kQ7CPSi",
"timestamp": "1647976101",
"type": "button",
"text": null,
"audio": null,
"document": null,
"image": null,
"location": null,
"video": null,
"voice": null,
"sticker": null,
"contacts": null,
"interactive": null,
"button": {
"payload": "3. Confirmar-Button-Payload",
"text": "Opción # 3"
}
}
],
"statuses": null,
"origin_number": "5731XXXXXXXX"
Ejemplo respuesta a Referral
Al recibir una respuesta con los datos de una publicación en Facebook; el json que se envía es el siguiente:
{
"contacts": [
{
"profile": {
"name": "William G."
},
"wa_id": "5731XXXXXXXX"
}
],
"messages": [
{
"context": null,
"from": "5731XXXXXXXX",
"id": "wamid.HBgMNTczMTM3MDA0NTM1FQIAEhgUM0VCMEMyOEE1RDgyOUIxM0EwMjMA",
"timestamp": "1659494612",
"type": "text",
"text": {
"body": "Vi esto en Facebook..."
},
"audio": null,
"document": null,
"image": null,
"location": null,
"video": null,
"voice": null,
"sticker": null,
"contacts": null,
"interactive": null,
"button": null,
"referral": {
"headline": "Cafgo",
"body": null,
"image": {
"file": null,
"id": null,
"link": "https://scontent.xx.fbcdn.net/v/t39.30808-
6/297001438_1107443033245737_2115644621831590924_n.jpg?stp=dstjpg_s851x315&_nc_cat=102&ccb=1- 7&_nc_sid=59d5e9&_nc_ohc=dOKN-uVzov8AX82UDKa&_nc_ad=zm&_nc_cid=0&_nc_ht=scontent.xx&oh=00_ATDD0Bkj6X3pvBnqKn_fdjbVaIVhFYCNSCYmFU47fFDFw&oe=62EF7288",
"sha256": null,
"caption": null,
"mime_type": null
},
"video": null,
"source_type": "post",
"source_id": "1107443223245718",
"source_url": "https://fb.me/3CJ2r7kWS"
}
}
],
"statuses": null,
"origin_number": "5732XXXXXXXX"
}Ejemplo respuesta con Producto
{
"contacts": [
{
"profile": {
"name": "Name contact"
},
"wa_id": "57319XXXXXXX"
}
],
"messages": [
{
"context": null,
"from": "57319XXXXXXX",
"id": "ABEGVzGUhxEJAhCgeeeGNUXbrH81cAnlSHd8",
"timestamp": "1659973484",
"type": "order",
"text": null,
"audio": null,
"document": null,
"image": null,
"location": null,
"video": null,
"voice": null,
"sticker": null,
"contacts": null,
"interactive": null,
"button": null,
"referral": null,
"order": {
"catalog_id": "Catalog id",
"product_items": [
{
"currency": "Type currency",
"quantity": Quantity products,
"item_price": Price products,
"product_retailer_id": "Product id"
}
]
}
}
],
"statuses": null,
"origin_number": "5730XXXXXXXX"
}Ejemplo respuesta con Lista de productos
{
"contacts": [
{
"profile": {
"name": "Name contact"
},
"wa_id": "57319XXXXXXX"
}
],
"messages": [
{
"context": null,
"from": "57319XXXXXXX",
"id": "ABEGVzGUhxEJAhCgeeeGNUXbrH81cAnlSHd8",
"timestamp": "1659973484",
"type": "order",
"text": null,
"audio": null,
"document": null,
"image": null,
"location": null,
"video": null,
"voice": null,
"sticker": null,
"contacts": null,
"interactive": null,
"button": null,
"referral": null,
"order": {
"catalog_id": "Catalog id",
"product_items": [
{
"currency": "Type currency",
"quantity": Quantity products,
"item_price": Price products,
"product_retailer_id": "Product id"
},
{
"currency": "USD",
"quantity": Quantity products,
"item_price": Price products,
"product_retailer_id": "Product id"
}
]
}
}
],
"statuses": null,
"origin_number": "5730XXXXXXXX"
}Errores
La respuesta a su llamada incluye una combinación de los siguientes componentes: meta, messages (payload), y errors. Visite WhatsApp Business API Responses para mayor detalle.
Si la solicitud tiene éxito, se recibe una respuesta con un ID de mensaje. Si la solicitud devuelve un errors sección, comprobar el mensaje de origen y corregir los errores antes de volver a enviar la solicitud. Para más información sobre los errores, véase WhatsApp Business API Client Error Codes y HTTP Status Codes.