Skip to main content
GET
Rufen Sie Nachrichten oder Konversationen für eine Messaging-Plattform ab. Die Abrufzeiten unterscheiden sich je nach sozialem Netzwerk. Auf Facebook, Instagram und WhatsApp sind Nachrichten über Ayrshare in Echtzeit verfügbar. Auf X/Twitter gibt es eine Verzögerung von bis zu 3 Minuten, bis neue Nachrichten-Updates sichtbar sind. Bitte wenden Sie sich an den Support, um mehr über den Enterprise Plan zu erfahren, wenn Sie Echtzeitzugriff auf X/Twitter-Nachrichten benötigen.
Response-Caching: Für Facebook und Instagram werden Antworten 60 Sekunden lang zwischengespeichert. Für X/Twitter werden Antworten 15 Sekunden lang zwischengespeichert, um Polling besser zu unterstützen. WhatsApp liest Nachrichten, die bereits über Meta-Webhooks empfangen wurden, sodass eine neu empfangene Nachricht erscheinen kann, sobald Ayrshare den Webhook verarbeitet hat. Die Antwort enthält weiterhin die Metadaten lastUpdated und nextUpdate.
Der initiale Abruf des Nachrichtenverlaufs für Facebook und Instagram ist auf die letzten 20 Nachrichten beschränkt. Weitere Informationen finden Sie im Abschnitt Abruf des Nachrichtenverlaufs für Facebook und Instagram.
WhatsApp-Konversationen werden anhand der Telefonnummer des Korrespondenten identifiziert (nur Ziffern, E.164 ohne führendes +). Eine gespeicherte ausgehende Nachricht kann einen status-Wert von sent, delivered, read oder failed enthalten.
WhatsApp-Nachrichten, die über Send Message gesendet werden, werden derzeit nicht dem Get-Messages-Verlauf hinzugefügt. Eingehende WhatsApp-Nachrichten, die über Webhooks empfangen werden, werden gespeichert und hier zurückgegeben.

Header-Parameter

Pfad-Parameter

string
erforderlich
Die Plattform, für die die Nachricht abgerufen werden soll: facebook, instagram, twitter, whatsapp

Query-Parameter

string
Standard:"active"
erforderlich
Gibt aktive oder archivierte Konversationen zurück. Werte: active oder archived.
string
Gibt nur die angegebene Konversation zurück.
string
Nur Nachrichten einer Richtung zurückgeben. Werte: sent oder received. Ohne Angabe werden beide zurückgegeben.
boolean
Standard:false
Gibt Konversationen statt Nachrichten zurück. Gibt eine Seite mit Konversationen zurück — folgen Sie meta.pagination.next für die restlichen. Bei true wird conversationId ignoriert.
Wenn conversationsOnly=true, werden die Konversationsdetails in converstationsDetails zurückgegeben. Diese Schreibweise ist Teil der aktuellen API-Antwort.
integer
Seitengröße für Nachrichten und für Konversationslisten: Ganzzahl von 1 bis 100, Standard und Maximum 100.Bei X/Twitter bestimmt limit zusätzlich, welche Menge an Nachrichten Sie lesen. Ohne limit werden Ihre gespeicherten Nachrichten seitenweise gelesen — so wie bei allen anderen Plattformen, und nur dabei greifen status, action und conversationsOnly. Mit limit wird stattdessen die Live-Timeline von X über den Cursor von X gelesen, wobei keiner dieser drei Filter angewendet wird.Diese Wahl trifft nur die erste Anfrage. Sobald Sie einem Cursor folgen, entscheidet der Cursor: ein Cursor für gespeicherte Nachrichten liefert weiterhin gespeicherte Nachrichten, auch wenn Sie limit senden, und ein X-Cursor liefert weiterhin die Live-Timeline, auch wenn Sie es weglassen. Ein Wechsel mitten in der Paginierung ist nicht möglich.
string
Opaker Cursor aus meta.pagination.next. Als next mit demselben Profil, derselben Plattform und denselben Filtern senden. Fortfahren, solange meta.pagination.hasMore true ist — auch wenn eine gefilterte Seite kurz oder leer zurückkommt. limit kann bei Folgeanfragen entfallen (Standard 100); bei X/Twitter hält der Cursor selbst fest, aus welcher Menge er stammt, sodass Senden oder Weglassen von limit nicht zur anderen wechselt.

Abrufen der nächsten Seite

Beginnen Sie mit GET /api/messages/instagram?limit=100. Um fortzufahren, URL-kodieren Sie den zurückgegebenen Wert aus meta.pagination.next und senden Sie GET /api/messages/instagram?limit=100&next=<opaque cursor>. Der Parameter heißt next, nicht cursor. Behalten Sie durchgehend denselben Profile-Key und dieselben Query-Filter bei. Prüfen Sie meta.pagination.hasMore, nicht die Anzahl der Ergebnisse, um zu entscheiden, wann Sie aufhören. Eine gefilterte Anfrage kann weniger als limit Ergebnisse zurückgeben oder eine leere Seite mit Fortsetzung, weil jede Anfrage einen begrenzten Ausschnitt der Historie durchsucht. Nachrichten in der gespeicherten Historie sind neueste zuerst sortiert, wobei die Dokument-ID bei Gleichstand entscheidet. Konversationslisten sind nach Dokument-ID sortiert. Das Paging ist kein eingefrorener Snapshot: Neue Nachrichten erscheinen, wenn Sie von der ersten Seite neu starten, und sich ändernde Konversationsstatus können gefilterte Ergebnisse verändern. Bestehende Nachrichtenfelder und die Schreibweise converstationsDetails sind unverändert. Integrationen, die bisher eine vollständige Liste aus einer einzigen Anfrage erwartet haben — ob von Nachrichten oder von Konversationen, auf jeder Plattform — müssen dem Fortsetzungs-Cursor folgen; ein limit über 100 wird nicht unterstützt.