الملفات والدفعات

سرد الدفعات

سرد الدفعات في مساحة العمل الحالية.

GET
/v1/batches

نظرة عامة

إرجاع الدفعات التي تم إنشاؤها عبر POST /v1/batches في مساحة العمل الحالية، بدءاً من الأحدث. يتم سرد دفعات الرسائل عبر سرد دفعات الرسائل.

معلمات الاستعلام

limitintegerqueryالافتراضي: 20
عدد الدفعات المراد إرجاعها، من 1 إلى 100.
afterstringquery
مؤشر معرّف الدفعة: إرجاع الدفعات التي تلي هذه الدفعة. استخدم last_id من الصفحة السابقة. لا يمكن دمجه مع before.
beforestringquery
مؤشر معرّف الدفعة: إرجاع الدفعات التي تسبق هذه الدفعة. لا يمكن دمجه مع after.
orderstringqueryالافتراضي: desc
asc أو desc، بحسب وقت الإنشاء.

مثال

الطلب

cURL
curl -X GET "https://api.tokenlab.sh/v1/batches?limit=20" \
  -H "Authorization: Bearer sk-your-api-key"

الاستجابة

200 OK
{
  "object": "list",
  "data": [{ "id": "batch_abc123", "object": "batch", "status": "completed" }],
  "first_id": "batch_abc123",
  "last_id": "batch_abc123",
  "has_more": false
}

الحقول المهمة

objectstring
دائماً list.
dataarray
الدفعات.
statusstring
حالة كل دفعة.
has_moreboolean
تتوفر المزيد من النتائج عندما تكون قيمة has_more هي true.

التفويض

BearerAuth
AuthorizationBearer <token>

مصادقة مفتاح API. قم بإنشاء أو إدارة مفاتيح API في Dashboard > API > API Keys.

الموضع: header

معاملات الاستعلام

limit?integer

عدد الدفعات المراد إرجاعها. الافتراضي 20.

النطاق1 <= value <= 100
الافتراضي20
after?string

مؤشر معرف الدفعة: إرجاع الدفعات بعد هذه الدفعة. لا يمكن دمجه مع before.

before?string

مؤشر معرف الدفعة: إرجاع الدفعات قبل هذه الدفعة. لا يمكن دمجه مع after.

order?string

ترتيب الفرز حسب وقت الإنشاء.

الافتراضي"desc"

القيم المتاحة

  • "asc"
  • "desc"

الاستجابة

application/json

application/json

application/json