Seitennavigation

Listen, die lang werden können, werden seitenweise zurückgegeben, mit den neuesten Einträgen zuerst: Jede Seite gibt an, wo die nächste beginnt. Andere Listen werden vollständig zurückgegeben.

Cursorbasierte Seiten

Nachrichten, E-Mail-Vorlagen und fehlgeschlagene Webhook-Zustellungen werden mithilfe eines Cursors auf Seiten verteilt:

  • Name
    limit
    Typ
    integer
    Beschreibung

    Die Anzahl pro Seite, von 1 bis 100; der Standardwert ist 25.

  • Name
    cursor
    Typ
    string
    Beschreibung

    Lassen Sie den Parameter für die erste Seite weg; senden Sie danach den Wert next der vorherigen Seite unverändert.

Jede Seite enthält ihre Einträge und next, das auf der letzten Seite null ist. Behandeln Sie einen Cursor als undurchsichtigen Wert und verwenden Sie für jede Liste nur deren eigenen Cursor: Die Formate unterscheiden sich, und ein Wert, der kein Cursor ist, wird mit 400 BAD_REQUEST abgelehnt.

Alle Nachrichten, eine Seite nach der anderen

cursor=''
while :; do
  page=$(curl -sG https://api.oblic.app/external/v1/messages \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d limit=100 ${cursor:+-d cursor="$cursor"})
  echo "$page" | jq -c '.data.messages[]'
  cursor=$(echo "$page" | jq -r '.data.next // empty')
  [ -z "$cursor" ] && break
done

Ein Cursor verweist auf den letzten Eintrag seiner Seite. Während des Abrufs hinzugefügte Einträge verschieben daher keine nachfolgenden Seiten: Sie stehen am Anfang und werden bei einem erneuten Abruf ab der ersten Seite gefunden.

Kontaktlisten

Die Kontaktlisten verwenden einen Offset im Pfad: /external/contact-list/v1/{nextIndex}/{limit}. Beginnen Sie bei 0; jede Seite gibt mit moreIndicator an, ob weitere Einträge vorliegen (Y oder N), und mit nextIndex, wo die nächste Seite beginnt.

Vollständige Listen

Absenderidentitäten, Webhook-Endpunkte, Unterkonten, SMS-Header und -Vorlagen sowie WhatsApp-Vorlagen werden vollständig und ohne Seiteneinteilung zurückgegeben.

War diese Seite hilfreich?