Skip to main content
GET
Obtén los mensajes o conversaciones de una plataforma de mensajería. Los tiempos de recuperación varían en cada red social. En Facebook, Instagram y WhatsApp, los mensajes están disponibles a través de Ayrshare en tiempo real. En X/Twitter hay un retraso de hasta 3 minutos para ver las nuevas actualizaciones de mensajes. Ponte en contacto con soporte para obtener más información sobre el Enterprise Plan si necesitas acceso en tiempo real a los mensajes de X/Twitter.
Caché de respuestas: para Facebook e Instagram, las respuestas se cachean durante 60 segundos. Para X/Twitter, se cachean durante 15 segundos para soportar mejor el sondeo (polling). WhatsApp lee los mensajes ya recibidos mediante los webhooks de Meta, por lo que un mensaje recién recibido puede aparecer en cuanto Ayrshare procese su webhook. La respuesta sigue incluyendo los metadatos lastUpdated y nextUpdate.
La recuperación inicial del historial de mensajes para Facebook e Instagram está limitada a los últimos 20 mensajes. Consulta la sección Recuperación del historial de mensajes para Facebook e Instagram para obtener más información.
Las conversaciones de WhatsApp se identifican por el número de teléfono del interlocutor (solo dígitos, E.164 sin el + inicial). Un mensaje saliente almacenado puede incluir un valor de status de sent, delivered, read o failed.
Los mensajes de WhatsApp enviados a través de Send Message no se añaden actualmente al historial de Get Messages. Los mensajes entrantes de WhatsApp recibidos a través de webhooks se almacenan y se devuelven aquí.

Parámetros de cabecera

Parámetros de ruta

string
requerido
La plataforma de la que obtener el mensaje: facebook, instagram, twitter, whatsapp

Parámetros de consulta

string
predeterminado:"active"
requerido
Devuelve conversaciones activas o archivadas. Valores: active o archived.
string
Devuelve únicamente la conversación especificada.
string
Devolver solo los mensajes de una dirección. Valores: sent o received. Omítelo para devolver ambos.
boolean
predeterminado:false
Devuelve conversaciones en lugar de mensajes. Devuelve una página de conversaciones: sigue meta.pagination.next para el resto. Si es true, se ignora conversationId.
Cuando conversationsOnly=true, los detalles de las conversaciones se devuelven en converstationsDetails. Esta grafía forma parte de la respuesta actual de la API.
integer
Tamaño de página para mensajes y para listas de conversaciones: entero de 1 a 100, con valor predeterminado y máximo de 100.En X/Twitter, limit también elige qué conjunto de mensajes lees. Omítelo para paginar tus mensajes almacenados, que es lo que hacen todas las demás plataformas y donde se aplican status, action y conversationsOnly. Proporciónalo para paginar en su lugar la cronología en vivo de X mediante el cursor propio de X, que no aplica ninguno de esos tres filtros.Esa elección la hace solo la primera solicitud. Una vez que sigues un cursor, decide el cursor: un cursor de mensajes almacenados sigue devolviendo mensajes almacenados aunque envíes limit, y un cursor de X sigue devolviendo la cronología en vivo aunque lo omitas. No puedes cambiar de uno a otro a mitad de la paginación.
string
Cursor opaco de meta.pagination.next. Envíalo como next con el mismo perfil, plataforma y filtros. Continúa mientras meta.pagination.hasMore sea true, incluso si una página filtrada llega corta o vacía. limit puede omitirse en solicitudes posteriores (predeterminado 100); en X/Twitter el cursor ya registra de qué conjunto proviene, así que enviar u omitir limit no te cambiará al otro.

Obtener la página siguiente

Empieza con GET /api/messages/instagram?limit=100. Para continuar, codifica en URL el valor devuelto en meta.pagination.next y envía GET /api/messages/instagram?limit=100&next=<opaque cursor>. El parámetro es next, no cursor. Mantén el mismo Profile-Key y los mismos filtros de consulta en todas las solicitudes. Comprueba meta.pagination.hasMore, no el número de resultados, para decidir cuándo detenerte. Una solicitud filtrada puede devolver menos de limit resultados, o una página vacía con continuación, porque cada solicitud examina una porción acotada del historial. Los mensajes en el historial almacenado se ordenan del más reciente al más antiguo, y el ID de documento desempata. Las listas de conversaciones se ordenan por ID de documento. La paginación no es una instantánea congelada: aparecen mensajes nuevos cuando reinicias desde la primera página, y los cambios de estado de las conversaciones pueden alterar los resultados filtrados. Los campos de mensaje existentes y la grafía converstationsDetails no cambian. Las integraciones que antes esperaban una lista completa en una sola solicitud — ya sea de mensajes o de conversaciones, en cualquier plataforma — deben seguir el cursor de continuación; no se admite aumentar limit por encima de 100.