الانتقال إلى المحتوى الرئيسي
GET
curl

نظرة عامة

يعيد هذا الطلب مهمة حذف جماعي للجلسات بدأها حذف الجلسات دفعةً واحدة، ويعرض حالتها وعدد الجلسات التي عالجتها وعدد الجلسات التي انتهت بكل نتيجة. عندما يتجاوز عدد جلسات KYC المطابقة لعملية الحذف الجماعي 20 جلسة، سواء اخترتها باستخدام session_numbers أو باستخدام delete_all، يعيد الطلب الاستجابة 202 مع مهمة بحالة PENDING، وتُحذف الجلسات في الخلفية. استعلم عن هذا endpoint كل بضع ثوانٍ حتى تصبح قيمة status إما COMPLETED أو FAILED. تُحذف كل جلسة تحذفها المهمة بالطريقة نفسها التي تُحذف بها عبر حذف الجلسة تماماً: تُحذف الجلسة وكل محاولة تحقق تابعة لها وجميع ملفاتها المخزّنة، ولا تعود روابط الوسائط الخاصة بها تعمل. الحذف نهائي ولا يمكن التراجع عنه. تعرض المهمة الأعداد فقط، ولا تسرد أبداً الجلسات التي حذفتها.

حالة المهمة

لا تحذف مهمة delete_all إلا الجلسات التي أُنشئت قبل الطلب. ولا تُحذف الجلسات التي تبدأ أثناء تشغيلها.

عدد النتائج

يحسب deleted_child_verifications عمليات التحقق التي أنشأتها عمليات التحقق من الشركات (KYB) المحذوفة، والتي حُذفت معها. وتكون قيمته دائماً 0 للمهمة التي بدأها حذف الجلسات دفعةً واحدة، لأنها تحذف جلسات KYC فقط.

الصلاحيات

يمكن لأي مفتاح API نشط للتطبيق استدعاء هذا endpoint. لا تكون المهمة مرئية إلا للتطبيق الذي أنشأها، وأي job_id آخر يعيد 404.

ذات صلة

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

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

job_id
string<uuid>
مطلوب

معرّف job_id المُرجع مع الرمز 202 من POST /v3/sessions/delete/.

الاستجابة

المهمة.

عملية حذف مجمع للجلسات قيد التشغيل في الخلفية: التقدم والأعداد لكل نتيجة، دون تحديد الجلسات التي حُذفت على الإطلاق.

job_id
string<uuid>

استعلم دورياً عن GET /v3/sessions/delete/{job_id}/ باستخدام هذا المعرّف.

status
enum<string>

PENDING: مقبولة، لم تبدأ بعد. PROCESSING: جارٍ الحذف؛ يجري تحديث processed وoutcomes. COMPLETED: تمت معالجة جميع الجلسات المحددة. FAILED: توقفت المهمة مبكراً؛ راجع error.

الخيارات المتاحة:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

الجلسات المحددة عند طلب الحذف.

processed
integer

الجلسات التي انتهت المهمة من معالجتها حتى الآن.

outcomes
object

عدد الجلسات التي انتهت بكل نتيجة. كل مفتاح موجود دائماً.

deleted_child_verifications
integer

عمليات التحقق التي أنشأتها عمليات التحقق من الشركات المحذوفة، والتي حُذفت معها. دائماً 0 للمهمة التي بدأت بواسطة POST /v3/sessions/delete/، والتي تحذف جلسات KYC فقط.

error
string | null

null ما لم تكن status هي FAILED؛ وحينها يبيّن سبب توقف الحذف. الجلسات التي لم تصل إليها المهمة تظل في مكانها: كرر الطلب لحذفها.

created_at
string<date-time>

وقت طلب الحذف.

completed_at
string<date-time> | null

متى انتهت المهمة؛ null أثناء تشغيلها.

آخر تعديل في ٧ نوفمبر ٢٠٢٦