Enviar mensaje

Envía mensajes de texto, multimedia o enriquecidos a cualquier número de teléfono o chat de grupo de WhatsApp a través del número de WhatsApp conectado en tu cuenta.

POST https://api.getincloud.ai/v1/messages

Envía mensajes de texto, multimedia o enriquecidos a cualquier número de teléfono o chat de grupo de WhatsApp a través del número de WhatsApp conectado en tu cuenta.

Funciones de mensajería disponibles según el plan de suscripción de cada número:

• Mensajes a usuarios - Compatible con todos los planes

• Mensajes multimedia - Envía imágenes, video, audio, GIF y documentos

• Mensajes programados - Todos los planes excepto Gateway Professional

• Mensajes a grupos - Compatible con todos los planes - Excepto números WABA API

• Mensajes a canales - Compatible con todos los planes excepto Gateway Professional - Excepto números WABA API

¿Cómo usar variables de plantilla en los mensajes?

Puedes usar la sintaxis de variables de plantilla para mostrar información dinámica en tus mensajes a partir de un conjunto de variables predefinidas.

La sintaxis de variables de plantilla se puede usar en cualquier mensaje de texto con llaves dobles {{ para abrir y }} para cerrar la expresión:

Dear {{ contact.name | customer }}, thanks for contacting us! We will answer your query shortly.

Conoce más sobre las variables de plantilla compatibles y ejemplos aquí

Tengo varios números conectados: ¿cómo envío mensajes a través de un número específico?

Si tienes varios números conectados a tu cuenta, debes especificar el campo device en el cuerpo JSON con el ID del dispositivo del número de WhatsApp de destino (valor hexadecimal de 24 caracteres) a través del cual quieres enviar los mensajes.

Si no se especifica el campo device, los mensajes se enviarán a través del primer número de WhatsApp conectado en tu cuenta.

Aquí tienes un ejemplo de cómo enviar un mensaje a través de un número de WhatsApp específico

Notas sobre la entrega de mensajes

• Los mensajes en cola no se entregan, por defecto, en orden estricto (FIFO), sino que se procesan como una cola de prioridad

• Para una entrega con orden estricto, puedes establecer el campo order en true en el cuerpo JSON para forzar el orden estricto de los mensajes en cola

• Los mensajes se entregan de forma asíncrona (modo cola) en los planes Gateway y en tiempo real (modo en vivo) en los planes Platform. Puedes personalizar el modo de entrega estableciendo el campo enqueue en always, never u opportunistic (por defecto) en el cuerpo JSON

Puedes consultar la [tabla de precios](/pricing) para más información sobre las funciones y limitaciones de la API compatibles por plan.

Tutoriales

• Enviar mensajes a números de teléfono

• Enviar mensajes a chats de grupo

• Enviar mensaje con botones dinámicos

• Enviar mensaje con lista dinámica

• Enviar mensajes multimedia (imágenes, videos, documentos, archivos o audios)

• Incluir emojis en mensajes de texto

• Enviar mensajes de ubicación

• Enviar contactos

• Enviar enlaces URL en mensajes de texto

• Enviar mensajes con caducidad automática

• Enviar mensajes en tiempo real sin cola

• Enviar mensajes a través de un número/dispositivo de WhatsApp específico

• Enviar mensajes en nombre de un agente de chat

• Enviar mensajes respondiendo a un mensaje específico

• Cómo usar variables de plantilla

• Cómo dar formato y estilo al texto en los mensajes

Pruebas de la API en vivo con ejemplos

Ir al probador de API en vivo con decenas de ejemplos

• Enviar mensaje a un número de teléfono

• Enviar mensaje a un grupo

• Enviar mensaje con imagen

• Enviar mensaje con video

• Enviar mensaje con audio

• Enviar mensaje multimedia con documento PDF

• Subir archivo desde una URL

• Enviar archivo multimedia a partir de un archivo subido

• Enviar mensaje programado

• Enviar mensaje de ubicación usando una dirección física

• Enviar encuesta a un usuario

• Enviar encuesta a un grupo

• Enviar votos en una encuesta existente de un usuario

• Enviar votos en una encuesta existente de un grupo

• Eliminar votos en una encuesta existente de un usuario

• Enviar mensaje con emojis

• Enviar mensaje con variables de plantilla

• Enviar mensaje con texto formateado

• Enviar mensaje con enlaces URL

• Enviar contactos

• Responder a otro mensaje

• Reenviar mensaje a otro chat

• Responder a un mensaje de botones o lista

• Enviar mensaje programado en una fecha específica

• Enviar mensajes con caducidad automática en una fecha específica

• Enviar mensaje a través de un número de WhatsApp específico

• Enviar mensaje en tiempo real sin cola

• Enviar mensaje de catálogo de productos

• Enviar reacción a un mensaje

• Eliminar reacción a un mensaje

• Enviar mensaje con un máximo de reintentos de entrega

• Enviar mensaje en orden estricto

• Enviar mensaje en nombre de un agente

• Enviar mensaje y asignar el chat a un agente

• Enviar mensaje y desasignar el chat de un agente

• Enviar mensaje y resolver el chat automáticamente

• Enviar mensaje y agregar etiquetas al chat

• Enviar mensaje y quitar etiquetas del chat

• Enviar mensaje y agregar metadatos al contacto del chat

• Enviar mensaje y eliminar metadatos del contacto del chat

• Enviar mensaje con formato de texto especial

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Parámetros

Cuerpo de la petición

Respuestas

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Send text message to a phone number
curl --request POST \
  --url https://api.getincloud.ai/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+1234567890","message":"Hello world! This is a test message."}'


// Send text message with high priority to a group
curl --request POST \
  --url https://api.getincloud.ai/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"group":"123456789000000000@g.us","priority":"high","message":"Hello world! This is a simple test message."}'


// Send media message to user. Note the file must be updated first, see API endpoint: Files > Upload file
curl --request POST \
  --url https://api.getincloud.ai/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+1234567890","message":"Hello world! This is a test media message.","media":{"file":"<24 characters length file ID>"}}'


// Send text message that should be delivered now
curl --request POST \
  --url https://api.getincloud.ai/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+1234567890","message":"Hello world! This is a simple test message.","enqueue":"never"}'


// Send a scheduled messages with a custom delay. See "schedule.delayTo" datetime notation shortcuts: https://i.ibb.co/g3DJLSH/datetime-shortcuts.png
curl --request POST \
  --url https://api.getincloud.ai/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+1234567890","schedule":{"delayTo":"1h"},"message":"Hello world! This is a simple test message."}'


// Send a scheduled messages at a concrete date with a valid ISO 8601 date
curl --request POST \
  --url https://api.getincloud.ai/v1/messages \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+1234567890","deliverAt":"2019-01-01T11:00:00.410Z","message":"Hello world! This is a simple test message."}'