تقسيم النتائج إلى صفحات
تُعاد القوائم التي قد تطول صفحةً تلو الأخرى، بدءًا بالأحدث: تحدد كل صفحة موضع بدء الصفحة التالية. أما القوائم الأخرى فتُعاد كاملة.
صفحات تعتمد على المؤشر
تستخدم الرسائل وقوالب البريد الإلكتروني وعمليات تسليم webhook الفاشلة التقسيم إلى صفحات بالمؤشر:
- اسم
limit- النوع
- integer
- وصف
عدد العناصر في الصفحة، من 1 إلى 100؛ والقيمة الافتراضية 25.
- اسم
cursor- النوع
- string
- وصف
لا ترسله للصفحة الأولى؛ ثم أرسل قيمة
nextمن الصفحة السابقة كما وردت.
تحتوي كل صفحة على عناصرها وقيمة next، وتكون null في الصفحة الأخيرة. تعامل مع المؤشر بوصفه قيمة معتمة، واستخدم لكل قائمة مؤشرها الخاص فقط: تختلف الصيغ بين القوائم، وتُرفض القيمة التي ليست مؤشرًا بالاستجابة 400 BAD_REQUEST.
كل الرسائل، صفحةً تلو الأخرى
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 موضع بدء الصفحة التالية.
القوائم الكاملة
تُعاد هويات المرسلين ونقاط نهاية webhook والحسابات الفرعية وترويسات SMS وقوالبها وقوالب WhatsApp كاملة، دون تقسيم إلى صفحات.