Buscar mensajes

Busca mensajes salientes, con la opción de filtrar por parámetros de búsqueda del cliente.

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/messages

Busca mensajes salientes, con la opción de filtrar por parámetros de búsqueda del cliente. Consulta los parámetros de búsqueda permitidos más abajo.

Importante:

Este endpoint solo devuelve mensajes salientes (enviados, en cola o fallidos); no busca entre mensajes salientes y entrantes (recibidos).

Para ese propósito, usa en su lugar el endpoint [Chat Messages](#operation/getDeviceMessages), que requiere una suscripción al plan Platform en el dispositivo de WhatsApp específico.

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

Campo	Dónde	Tipo	Obligatorio	Descripción
`search`	query	string	No	Busca mensajes por contenido de texto, número de teléfono, grupo o IDs de mensaje `minLength: 1` · `maxLength: 150`
`status`	query	array	No
`deliveryStatus`	query	array	No
`webhookStatus`	query	array	No
`include`	query	array	No	Expande los documentos de subentidades por mensaje
`ids`	query	array	No
`agents`	query	array	No	Filtra los mensajes enviados por los IDs de agentes específicos
`source`	query	string	No	Origen de creación del mensaje. Las opciones posibles son mediante la interfaz de chat web o la API `enum: ['chat', 'api']`
`target`	query	string	No	Tipo de chat del destino del mensaje `enum: ['user', 'group', 'channel']`
`type`	query	array	No	Busca mensajes por tipo
`waIds`	query	array	No	Busca mensajes por ID de WhatsApp (20 o 22 caracteres). Se permiten varios IDs separados por comas
`devices`	query	array	No
`device`	query	string	No	Busca mensajes por ID del dispositivo de origen o número de teléfono del dispositivo `minLength: 9` · `maxLength: 24`
`reference`	query	array	No
`priority`	query	array	No
`phone`	query	string	No	Filtra mensajes por número de teléfono de destino en formato internacional E.164. Agregar el prefijo `+` es opcional; sin embargo, si lo agregas, asegúrate de codificarlo de forma segura para URL como `%20`. `minLength: 6` · `maxLength: 17` · `pattern: ^\+?[0-9]{5,16}$`
`chat`	query	string	No	Filtra mensajes por el ID de WhatsApp (WID) del chat de destino. Es obligatorio para filtrar por un contacto que oculta su número de teléfono, ya que esos mensajes no tienen valor en `phone`. Ej.: `PE.1045742271480925@bsuid`, `1234567890@c.us` `minLength: 6` · `maxLength: 141`
`group`	query	string	No	Filtra mensajes por el ID de WhatsApp del grupo de destino. Ej.: 1234567890-5729392582@g.us, 1203630123456789001@g.us `minLength: 2` · `maxLength: 50`
`channel`	query	string	No	Filtra mensajes por el ID de WhatsApp del canal de destino, con o sin su sufijo @newsletter. Ej.: 123000098765421000@newsletter `minLength: 10` · `maxLength: 50`
`after`	query	string	No	Entregados después de la fecha indicada `format: date-time`
`before`	query	string	No	Entregados antes de la fecha indicada `format: date-time`
`createdAfter`	query	string	No	Mensajes creados después de la fecha indicada `format: date-time`
`createdBefore`	query	string	No	Mensajes creados antes de la fecha indicada `format: date-time`
`sort`	query	string	No	Orden de clasificación, por fecha de creación o de entrega. Por defecto, se listan primero los mensajes más recientes. `enum: ['deliverAt:asc', 'deliverAt:desc', 'createdAt:asc', 'createdAt:desc']` · `default: createdAt:desc`
`page`	query	number	No	Número de página de resultados (empezando en 0) `minimum: 0` · `maximum: 500` · `default: 0` · `format: integer`
`size`	query	number	No	Tamaño de los resultados `minimum: 1` · `maximum: 100` · `default: 20` · `format: integer`

Respuestas

Código	Descripción
`200`	Mensajes
`400`	Datos de consulta o cuerpo de la solicitud no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos necesarios
`404`	Recurso no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio 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 latest queued messages
curl --request GET \
  --url 'https://api.getincloud.ai/v1/messages?size=50&page=0&status=queued' \
  --header 'Token: <api token goes here>'


// Get failed messages
curl --request GET \
  --url 'https://api.getincloud.ai/v1/messages?size=50&status=failed' \
  --header 'Token: <api token goes here>'


// Get messages sent to a phone number
curl --request GET \
  --url 'https://api.getincloud.ai/v1/messages?size=30&status=processed&phone=%2B123456789' \
  --header 'Token: <api token goes here>'


// Get messages by ID with any status
curl --request GET \
  --url 'https://api.getincloud.ai/v1/messages?size=10&status=any&search=5c4c839c7425ae1e09943513' \
  --header 'Token: <api token goes here>'

AnteriorActualizar mensaje en cola SiguienteEliminar mensaje

¿Te sirvió esta página?