ページネーション

件数が多くなるリストは、新しい項目から順に1ページずつ返されます。各ページには次のページの開始位置が含まれます。それ以外のリストは全件が返されます。

カーソルベースのページ

メッセージ、メールテンプレート、失敗したwebhook配信はカーソルでページを取得します。

  • 名前
    limit
    タイプ
    integer
    説明

    1ページあたりの件数です。1から100まで指定でき、既定値は25です。

  • 名前
    cursor
    タイプ
    string
    説明

    最初のページでは省略し、次のページからは前のページのnextを変更せずに送信します。

各ページには項目とnextが含まれ、最後のページではnullになります。カーソルは内容を解釈せずに扱い、各リストにはそのリスト自身のカーソルだけを送信してください。形式はリストごとに異なり、カーソルでない値は400 BAD_REQUESTで拒否されます。

すべてのメッセージを1ページずつ取得する

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

カーソルはそのページの最後の項目を示すため、取得中に項目が追加されても、それ以降のページがずれることはありません。追加された項目は先頭に表示され、最初のページから読み直すと取得できます。

連絡先リスト

連絡先リストはパス内のオフセットでページを取得します。パスは/external/contact-list/v1/{nextIndex}/{limit}です。0から開始してください。各ページのmoreIndicatorは続きの有無(YまたはN)を示し、nextIndexは次のページの開始位置を示します。

全件を返すリスト

送信者ID、webhookエンドポイント、サブアカウント、SMSヘッダーとテンプレート、WhatsAppテンプレートは、ページに分割せず全件が返されます。

このページは役に立ちましたか?