تخطَّ إلى المحتوى

تقسيم الصفحات

تعيد كل نقاط النهاية التي تعرض قوائم الغلاف نفسه، حتى القوائم القصيرة مثل الأجهزة أو webhooks:

{
"data": [
{ "id": "msg_q8v2k4n6p1r3t5w7y9z0b2c4", "status": "delivered" },
{ "id": "msg_h3j5l7n9q2s4u6w8y1a3c5e7", "status": "sent" }
],
"nextCursor": "bXNnX2gzajVsN245cTJzNHU2dzh5MWEzYzVlNw"
}

تكون nextCursor بالقيمة null في الصفحة الأخيرة. القوائم مرتبة من الأحدث إلى الأقدم.

الاستعلام الافتراضي النطاق الوصف
limit 50 من 1 إلى 200 عدد العناصر في الصفحة.
cursor قيمة nextCursor من الصفحة السابقة. اتركه في الصفحة الأولى.

تعامل مع المؤشر كنص مبهم ومرّره كما وصلك تماما. المؤشر الذي لم تصدره الواجهة البرمجية يعيد 400 invalid_cursor. حافظ على عوامل التصفية نفسها في كل الصفحات، فتغييرها في المنتصف يعطي نتائج غير متسقة.

التصفح بالمؤشر مستقر أثناء وصول عناصر جديدة. الرسالة التي تُنشأ أثناء تصفحك تظهر في بداية القائمة، فلا تزيح الصفحات التي تقرأها.

نافذة طرفيّة
cursor=""
while :; do
page=$(curl -s "https://api.smsfabric.com/v1/messages?status=failed&limit=200${cursor:+&cursor=$cursor}" \
-H "X-Api-Key: $SMSFABRIC_API_KEY")
echo "$page" | jq -r '.data[] | "\(.id) \(.errorCode)"'
cursor=$(echo "$page" | jq -r '.nextCursor // empty')
[ -z "$cursor" ] && break
done

نقاط النهاية المقسمة إلى صفحات

Section titled “نقاط النهاية المقسمة إلى صفحات”

هذه تقبل limit وcursor: GET /v1/messages وGET /v1/verifications وGET /v1/contacts وGET /v1/contact-groups وGET /v1/contact-imports وGET /v1/templates وGET /v1/campaigns وGET /v1/blacklist وGET /v1/webhooks/:id/deliveries وGET /v1/audit.

وهذه تعيد القائمة كاملة في صفحة واحدة مع nextCursor: null: GET /v1/devices وGET /v1/pools وGET /v1/webhooks وGET /v1/api-keys وGET /v1/org/members وGET /v1/org/invitations.

لنسخة كاملة من سجل رسائلك، يبث GET /v1/messages/export.csv كل الصفوف المطابقة في استجابة واحدة.