Paginazione
Gli elenchi che possono diventare lunghi vengono restituiti una pagina alla volta, con gli elementi più recenti per primi: ogni pagina indica dove inizia la successiva. Gli altri vengono restituiti per intero.
Pagine con cursore
I messaggi, i modelli email e le consegne webhook non riuscite usano la paginazione con cursore:
- Nome
limit- Tipo
- integer
- Descrizione
Il numero di elementi per pagina, da 1 a 100; il valore predefinito è 25.
- Nome
cursor- Tipo
- string
- Descrizione
Ometterlo per la prima pagina; inviare poi il valore
nextdella pagina precedente senza modificarlo.
Ogni pagina contiene i propri elementi e next, che è null nell'ultima pagina. Trattare il cursore come un valore opaco e usare per ogni elenco solo il relativo cursore: i formati differiscono tra gli elenchi e un valore che non è un cursore viene rifiutato con 400 BAD_REQUEST.
Tutti i messaggi, una pagina alla volta
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
Un cursore identifica l'ultimo elemento della propria pagina, quindi gli elementi aggiunti durante la lettura non spostano le pagine successive: compaiono all'inizio e si trovano ripartendo dalla prima pagina.
Elenchi di contatti
Gli elenchi di contatti usano un offset nel percorso: /external/contact-list/v1/{nextIndex}/{limit}. Iniziare da 0; ogni pagina indica in moreIndicator se ci sono altri risultati (Y o N) e in nextIndex dove inizia la pagina successiva.
Elenchi completi
Identità dei mittenti, endpoint webhook, sottoaccount, intestazioni e modelli SMS e modelli WhatsApp vengono restituiti per intero, senza paginazione.