Saltar al contenido principal

Tipo de datos de Mensajes

Conoce los diferentes tipos de datos (texto, imagen, audio, video, archivo, sticker y ubicación) que se pueden enviar como mensajes a través de la API de Jelou.

Antes de enviar un mensaje, elige el tipo de dato de desaeas incluir en tu mensaje, segun tu necesidad. Puedes seleccionar entre varios formatos como texto, audio, imagen, entre otros.

1. Mensaje de Texto

Un mensaje de texto es un mensaje enviado en texto plano.

Este campo almacenará el mensaje que se enviará al cliente.

Ejemplo de solicitud API (cURL)

Enviar un mensaje de texto a un usuario específico.

curl -X "POST" "https://api.jelou.ai/v1/whatsapp/messages" \
-H 'Content-Type: application/json' \
-u '<clientId>:<clientSecret>' \
-d '{
"text": "<mensaje>",
"userId": "<userId>",
"botId": "<botId>",
"type": "text"
}'

2. Mensaje de Texto con Opciones

Un mensaje de texto con opciones incluye texto plano con botones de selección.

Parámetros

PropiedadDescripciónObligatorio
textContenido del mensaje.
buttonsConfiguración de botones.
buttons.titleTítulo sobre el mensaje.No
buttons.buttonTextTexto del botón principal.No
buttons.buttonText.typeTipo de dato de visualización del botón.Sí (si se usa buttonText)
buttons.buttonText.textTexto en el botón principal (Predeterminado: "Opciones").Sí (si se usa buttonText)
buttons.optionsLista de opciones disponibles (mínimo 1, máximo 10).
buttons.options.*.titleTítulo de cada opción (Máximo 24 caracteres).
buttons.options.*.descriptionDescripción de la opción (Máximo 72 caracteres).No
buttons.options.*.payloadTexto enviado al webhook al seleccionar la opción.No

Ejemplo de solicitud API (cURL)

Enviar un mensaje con opciones a un usuario específico.

curl -X "POST" "https://api.jelou.ai/v1/whatsapp/messages" \
-H 'Content-Type: application/json' \
-u '<clientId>:<clientSecret>' \
-d '{
"text": "<mensaje>",
"userId": "<userId>",
"botId": "<botId>",
"type": "text",
"buttons": {
"title": "<Título Principal>",
"buttonText": {
"type": "text",
"text": "<Texto Botón Principal>"
},
"options": [
{
"title": "<Opción 1>",
"description": "<Descripción Opción 1>",
"payload": "<Texto_Retorno_1>"
},
{
"title": "<Opción 2>",
"description": "<Descripción Opción 2>",
"payload": "<Texto_Retorno_2>"
}
]
}
}'

3. Mensaje con Imagen

Un mensaje con imagen es un mensaje que incluye una imagen y un texto opcional.

Parámetros

PropiedadDescripciónObligatorio
mediaUrlURL de la imagen a enviar.
textMensaje que acompaña la imagen.No

Ejemplo de solicitud API (cURL)

Enviar una imagen a un usuario específico.

curl -X "POST" "https://api.jelou.ai/v1/whatsapp/messages" \
-H 'Content-Type: application/json' \
-u '<clientId>:<clientSecret>' \
-d '{
"text": "<mensaje opcional>",
"mediaUrl": "<url_imagen>",
"userId": "<userId>",
"botId": "<botId>",
"type": "image"
}'

4. Mensaje de Audio

Un mensaje de audio es un mensaje que se envía como un archivo de audio.

Parámetros

PropiedadDescripciónObligatorio
mediaUrlURL del archivo de audio a enviar.

Ejemplo de solicitud API (JSON)

{
"mediaUrl": "<url_audio>",
"userId": "<userId>",
"botId": "<botId>",
"type": "audio"
}

5. Mensaje con Video

Un mensaje con video es un mensaje que se envía con un video y un texto opcional.

Parámetros

PropiedadDescripciónObligatorio
mediaUrlURL del archivo de video a enviar.
textMensaje que acompaña el video.No

Ejemplo de solicitud API (JSON)

{
"mediaUrl": "<url_video>",
"text": "<mensaje opcional>",
"userId": "<userId>",
"botId": "<botId>",
"type": "video"
}

5. Mensaje con Video

Un mensaje con video es un mensaje que se envía con un video y un texto opcional.

Parámetros

PropiedadDescripciónObligatorio
mediaUrlURL del archivo de video a enviar.
textMensaje que acompaña el video.No

Ejemplo de solicitud API (JSON)

{
"mediaUrl": "<url_video>",
"text": "<mensaje opcional>",
"userId": "<userId>",
"botId": "<botId>",
"type": "video"
}

6. Mensaje con Archivo

Un mensaje con archivo es un mensaje que se envía con un archivo y texto opcional.

Parámetros

PropiedadDescripciónObligatorio
mediaUrlURL del archivo a enviar.
textMensaje que acompaña el archivo.No

Ejemplo de solicitud API (JSON)

{
"mediaUrl": "<url_archivo>",
"userId": "<userId>",
"botId": "<botId>",
"type": "file"
}

7. Mensaje con Sticker

Un mensaje con sticker es un mensaje que se envía con un sticker.

Parámetros

PropiedadDescripciónObligatorio
mediaUrlURL del archivo del sticker a enviar.

Ejemplo de solicitud API (JSON)

{
"mediaUrl": "<url_sticker>",
"userId": "<userId>",
"botId": "<botId>",
"type": "sticker"
}

8. Mensaje con Ubicación

Un mensaje con ubicación es un mensaje que se envía con una ubicación específica.

Parámetros

PropiedadDescripciónObligatorio
coordinatesObjeto que contiene la latitud y longitud de la ubicación.
coordinates.latLatitud de la ubicación (número decimal).
coordinates.longLongitud de la ubicación (número decimal).

Ejemplo de solicitud API (JSON)

{
"coordinates": {
"lat": <latitud>,
"long": <longitud>
},
"userId": "<userId>",
"botId": "<botId>",
"type": "location"
}

9. Respuestas Rápidas

Un mensaje de Tipo de dato "respuestas rápidas" es un mensaje que ofrece una manera más rápida para que los usuarios seleccionen una opción de un menú al interactuar con un negocio.

Parámetros

PropiedadDescripciónObligatorio
textContenido del mensaje a enviar al cliente.
titleTítulo del mensaje.No
quick_repliesBotones de respuestas rápidas.
quick_replies.*.titleTexto de cada botón de respuesta rápida.
  • quick_replies -> Mínimo 1 y máximo 3 botones.
  • title -> Opcional. Longitud máxima: 20 caracteres.
  • quick_replies.*.title -> No puede ser una cadena vacía y debe ser único dentro del mensaje. Longitud máxima: 20 caracteres. No permite emojis ni markdowns.

Ejemplo de solicitud API (cURL)

Enviar un mensaje de "Respuesta Rápida" a un usuario específico.

curl -X "POST" "https://api.jelou.ai/v1/whatsapp/messages" \
-H 'Content-Type: application/json' \
-u '<clientId>:<clientSecret>' \
-d $'{
"text": "<mensaje>",
"title": "<Título del mensaje>",
"quick_replies": [
{
"title": "<TÍTULO_BOTÓN_1>"
},
{
"title": "<TÍTULO_BOTÓN_2>"
},
{
"title": "<TÍTULO_BOTÓN_3>"
}
],
"userId": "<userId>",
"botId": "<botId>",
"type": "quick_reply"
}'

Tipo de datos de Medios Admitidos

MedioTipo de datos AdmitidosLímite de Tamaño
audioaudio/aac, audio/mp4, audio/mpeg, audio/amr, audio/ogg (solo códecs opus, audio/ogg base no es compatible)16MB
archivotext/plain, application/pdf, application/vnd.ms-powerpoint, application/msword, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet100MB
imagenimage/jpeg, image/png5MB
videovideo/mp4, video/3gp16MB
stickerimage/webp100KB