الملفات والدفعات
استرجاع دفعة الرسائل
استرجاع حالة وعدد طلبات دفعة الرسائل (Message Batch).
نظرة عامة
إرجاع الحالة، وعدد الطلبات، والطوابع الزمنية لدفعة رسائل أنشأتها مؤسستك. قم باستطلاع (Poll) نقطة النهاية هذه حتى تصبح قيمة processing_status هي ended، ثم احصل على النتائج.
ملاحظات
- يمكن أن تكون قيمة
processing_statusهيin_progressأوcancelingأوended. - تكون قيمة
results_urlهيnullحتى تنتهي الدفعة. - الدفعة غير الموجودة أو التي تم حذفها تُرجع
404. الدفعة التي لم تصبح جاهزة للقراءة بعد قد تُرجع409؛ حاول مرة أخرى لاحقاً.
الطلب
curl -X GET "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
-H "x-api-key: sk-your-api-key" \
-H "anthropic-version: 2023-06-01"الاستجابة
{
"id": "msgbatch_01ABC123",
"type": "message_batch",
"processing_status": "ended",
"request_counts": {
"processing": 0,
"succeeded": 2,
"errored": 0,
"canceled": 0,
"expired": 0
},
"ended_at": "2026-11-01T10:20:00Z",
"created_at": "2026-11-01T10:00:00Z",
"expires_at": "2026-11-02T10:00:00Z",
"cancel_initiated_at": null,
"archived_at": null,
"results_url": "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/results"
}حقول هامة
processing_statusstring
تكون
in_progress أو canceling أو ended.request_countsobject
عدد الطلبات التي هي في حالة
processing أو succeeded أو errored أو canceled أو expired.ended_atstring|null
وقت انتهاء المعالجة، أو
null.cancel_initiated_atstring|null
وقت قبول طلب الإلغاء، أو
null.results_urlstring|null
رابط URL الخاص بالنتائج، أو
null.التفويض
BearerAuth AuthorizationBearer <token>
مصادقة مفتاح API. قم بإنشاء أو إدارة مفاتيح API في Dashboard > API > API Keys.
الموضع: header
معاملات المسار
message_batch_id*string
معرف دفعة الرسائل.
الاستجابة
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json