API de WhatsApp y CRM
GET/chat/{deviceId}/messages

Buscar mensajes

Recupera mensajes de todos los chats o de un chat específico, con la opción de filtrarlos mediante parámetros de búsqueda (consulta los parámetros aceptados más abajo) ---- Prueba este endpoint en el probador de AP

API de WhatsApp y CRM
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
GET https://api.getincloud.ai/v1/chat/{deviceId}/messages

Recupera mensajes de todos los chats o de un chat específico, con la opción de filtrarlos mediante parámetros de búsqueda (consulta los parámetros aceptados más abajo)

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

CampoDóndeTipoObligatorioDescripción
flowquerystringNoFiltra por mensajes entrantes o salientes enum: ['in', 'out']
ackqueryarrayNoFiltra los mensajes por estado de confirmación de entrega (ACK) maximum: 8
widqueryarrayNoFiltra los mensajes por WID (WhatsApp ID). Se permiten varios valores separados por comas. minimum: 1 · maximum: 50
searchquerystringNoBusca mensajes por contenido parcial del texto, nombre del contacto o nombre del archivo multimedia maxLength: 100
chatqueryarrayNoFiltra los mensajes por el WhatsApp ID del chat. Este filtro funciona para chats de usuarios, grupos y canales. Por ejemplo: 1234567890@c.us, 123456789000000000@g.us, 123000098765421000@newsletter
fromquerystringNoDevuelve los mensajes enviados desde un número de teléfono o WID de WhatsApp determinado minLength: 9 · maxLength: 32
toquerystringNoDevuelve los mensajes recibidos en el número de teléfono o WID de WhatsApp indicado minLength: 9 · maxLength: 32
typequeryarrayNoFiltra los mensajes por tipo de mensaje. Acepta los mismos valores de type con los que se devuelven los mensajes. Para recuperar únicamente los mensajes de un grupo o de un canal, utiliza en su lugar el filtro chat con el WhatsApp ID del chat de destino
referencequerystringNoFiltra los mensajes por coincidencia exacta del campo de referencia minLength: 1 · maxLength: 150
kindqueryarrayNoFiltra los mensajes por tipo de entrada default: message,note
syncquerybooleanNoSi aún no hay mensajes disponibles, sincroniza los mensajes desde la sesión de WhatsApp. La sesión debe estar en línea para poder sincronizar los mensajes; de lo contrario, la API devolverá un error 503 de servicio no disponible default: False
beginquerystringNoDevuelve los mensajes más recientes a partir del ID de mensaje indicado, excluyéndolo de los resultados. Ten en cuenta que, por defecto, los mensajes se ordenan de forma descendente por fecha de creación, a menos que pases explícitamente el parámetro de consulta sort=date:asc. minLength: 18 · maxLength: 50
endquerystringNoDevuelve los mensajes más antiguos a partir del ID de mensaje indicado, excluyéndolo de los resultados. minLength: 18 · maxLength: 50
afterquerystringNoMensajes creados después de la fecha indicada format: date-time
beforequerystringNoMensajes creados antes de la fecha indicada format: date-time
includequeryarrayNoIncluye documentos relacionados anidados por cada mensaje
sortqueryarrayNoOrdenación de mensajes: primero los más recientes o primero los más antiguos
pagequerynumberNoNúmero de página de resultados (empezando en 0) minimum: 0 · maximum: 500 · default: 0 · format: integer
sizequerynumberNoTamaño de página de resultados minimum: 1 · maximum: 50 · default: 20 · format: integer
skipquerynumberNoSolo aplica si sync=true. Omite los mensajes anteriores. Para la paginación de resultados usa el parámetro page. minimum: 0 · maximum: 2000 · default: 0 · format: integer

Respuestas

CódigoDescripción
200Mensajes
400Datos de consulta o de cuerpo de la solicitud no válidos
401No autorizado: token de API no válido o ausente
403Faltan los permisos requeridos
404Recurso no encontrado
409Conflicto
429Demasiadas solicitudes: inténtalo de nuevo más tarde
500Error inesperado
501No implementado
503Servicio no disponible temporalmente: inténtalo de nuevo más tarde
// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Get most recent messages
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?size=20&page=0' \
  --header 'Token: <api token goes here>'


// Get image and video messages only
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?type=image%2Cvideo' \
  --header 'Token: <api token goes here>'


// Get messages for a specific channel
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?chat=123000098765421000%40newsletter&size=50' \
  --header 'Token: <api token goes here>'


// Get messages send from a phone number 
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?from=1234567890' \
  --header 'Token: <api token goes here>'


// Get messages for a specific user chat
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?chat=1234567890&size=50' \
  --header 'Token: <api token goes here>'


// Get messages for a specific group
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?chat=123456789000000000%40g.us&size=50' \
  --header 'Token: <api token goes here>'


// Get new messages after the given message ID
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?begin=3EB0F404610000EAE10E&chat=1234567890&size=50' \
  --header 'Token: <api token goes here>'


// Sync old messages, if required, from WhatsApp live session (requires chat param to be present)
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/messages?chat=1234567890&size=50&sync=true' \
  --header 'Token: <api token goes here>'
AnteriorBuscar estadosSiguienteContactos
¿Te sirvió esta página?