Buscar estados

Busca el historial de actualizaciones de estados de usuario, con filtros opcionales mediante parámetros de búsqueda.

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}/status

Busca el historial de actualizaciones de estados de usuario, con filtros opcionales mediante parámetros de búsqueda. Puedes consultar el historial de estados de publicaciones anteriores siempre que hayan sido sincronizados con la plataforma, incluso cuando hayan expirado después de 24 horas desde su publicación.

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
`flow`	query	string	No	Filtra por mensajes entrantes o salientes `enum: ['in', 'out']`
`mine`	query	boolean	No	Establece `true` para devolver los estados publicados por tu propio número de WhatsApp `default: False`
`scheduled`	query	boolean	No	Devuelve solo los estados programados que se publicarán en el futuro. Nota: la estructura de datos devuelta es diferente a la de la respuesta de estados normales que ya han sido procesados por WhatsApp `default: False`
`ack`	query	array	No	Filtra los mensajes por estado de ACK de entrega `maximum: 8`
`wid`	query	array	No	Filtra estados por WID (WhatsApp ID). Se permiten varios valores separados por comas. `minimum: 1` · `maximum: 50`
`search`	query	string	No	Busca estados por contenido de texto parcial, nombre del contacto o nombre de archivo multimedia `maxLength: 100`
`chat`	query	string	No	Filtra estados por el WhatsApp ID del chat. Este filtro funciona para chats de usuarios, grupos y canales. Ej.: `1234567890@c.us`, `123456789000000000@g.us`, `123000098765421000@newsletter` `minLength: 9` · `maxLength: 40`
`phone`	query	string	No	Devuelve los estados enviados desde un número de teléfono o WID de WhatsApp determinado `minLength: 9` · `maxLength: 32`
`type`	query	array	No	Filtra las actualizaciones de estado por tipo de mensaje
`reference`	query	string	No	Filtra los mensajes por coincidencia exacta del campo de referencia `minLength: 1` · `maxLength: 150`
`kind`	query	array	No	Filtra los mensajes por tipo de entrada
`begin`	query	string	No	Devuelve 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`
`end`	query	string	No	Devuelve los mensajes más antiguos a partir del ID de mensaje indicado, excluyéndolo de los resultados. `minLength: 18` · `maxLength: 50`
`after`	query	string	No	Mensajes creados después de la fecha indicada `format: date-time`
`before`	query	string	No	Mensajes creados antes de la fecha indicada `format: date-time`
`sort`	query	array	No	Orden de los mensajes: más recientes primero o más antiguos primero
`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 página de resultados `minimum: 1` · `maximum: 50` · `default: 20` · `format: integer`

Respuestas

Código	Descripción
`200`	Estados de usuario
`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 requeridos
`404`	Recurso no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio temporalmente no disponible: 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 user statuses
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/status?size=20&page=0' \
  --header 'Token: <api token goes here>'


// Get my own statuses
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/status?mine=true' \
  --header 'Token: <api token goes here>'


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


// Get scheduled user statuses
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/status?scheduled=true&size=50' \
  --header 'Token: <api token goes here>'

AnteriorBuscar chats SiguienteBuscar mensajes

¿Te sirvió esta página?