Paginação

As listas que podem crescer são retornadas uma página por vez, com os itens mais recentes primeiro: cada página indica onde começa a seguinte. As demais são retornadas por completo.

Páginas com cursor

As mensagens, os modelos de e-mail e as entregas de webhooks com falha são paginados por cursor:

  • Nome
    limit
    Tipo
    integer
    Descrição

    A quantidade de itens por página, de 1 a 100; o padrão é 25.

  • Nome
    cursor
    Tipo
    string
    Descrição

    Omita este parâmetro na primeira página; depois envie o valor next da página anterior sem alterá-lo.

Cada página contém seus itens e next, que é null na última página. Trate o cursor como um valor opaco e envie a cada lista apenas o cursor dela: os formatos variam entre listas, e um valor que não seja um cursor é recusado com 400 BAD_REQUEST.

Todas as mensagens, uma página por vez

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

Um cursor identifica o último item da sua página. Assim, itens adicionados durante a paginação não deslocam as páginas seguintes: eles aparecem no início e são encontrados ao consultar novamente a partir da primeira página.

Listas de contatos

As listas de contatos são paginadas por deslocamento no caminho: /external/contact-list/v1/{nextIndex}/{limit}. Comece em 0; cada página informa em moreIndicator se há mais resultados (Y ou N) e em nextIndex onde começa a próxima página.

Listas completas

Identidades de remetente, endpoints de webhooks, subcontas, cabeçalhos e modelos de SMS e modelos do WhatsApp são retornados por completo, sem paginação.

Esta página foi útil?