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

إلغاء دفعة الرسائل

إلغاء دفعة رسائل (Message Batch) لا تزال قيد المعالجة.

POST
/v1/messages/batches/{message_batch_id}/cancel

نظرة عامة

طلب إلغاء دفعة رسائل لا تزال قيد المعالجة. يوضح الرد الحالة الحالية. عادة ما تكون قيمة processing_status هي canceling، وقد تستمر الطلبات التي بدأت بالفعل في الاكتمال. أما الدفعة التي انتهت بالفعل فيتم إرجاعها دون تغيير.

ملاحظات

  • بعد الإلغاء، استمر في استرجاع حالة الدفعة حتى تصبح قيمة processing_status هي ended. الطلبات التي لم تبدأ ستنتهي بحالة canceled.
  • الدفعة غير الموجودة أو التي تم حذفها ستعيد الخطأ 404. الدفعة التي ليست جاهزة للتعديل بعد ستعيد الخطأ 409؛ يرجى المحاولة لاحقاً.
  • الإلغاء لا يؤدي إلى حذف الدفعة. لإزالتها، قم بـ حذفها بعد أن تنتهي.

مثال

الطلب

cURL
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

مثال على الرد

الاستجابة

200 OK
{
  "id": "msgbatch_01ABC123",
  "type": "message_batch",
  "processing_status": "canceling",
  "request_counts": {
    "processing": 1,
    "succeeded": 1,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": "2026-11-01T10:05:00Z",
  "archived_at": null,
  "results_url": null
}

حقول هامة

processing_statusstring
تكون القيمة canceling أثناء إجراء عملية الإلغاء، وتصبح ended بمجرد اكتمالها. لا تفترض أن كل طلب إلغاء سيعيد الحالة canceling.
cancel_initiated_atstring|null
الوقت الذي تم فيه قبول طلب الإلغاء، أو 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