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

التفويضات

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.

الجسم

application/json
email
string<email>
مطلوب

عنوان البريد الإلكتروني للمستلم. تُرجع العناوين المشوهة غير الصالحة 400؛ أما العناوين الصالحة لغوياً ولكنها لا تستطيع تلقي البريد (فشل التحقق من DNS/MX) فتُرجع 200 مع status: "Undeliverable".

مثال:

"alice@example.com"

options
object

تنسيق رمز لمرة واحدة، والتوطين، وخيارات العلامة التجارية. جميع الحقول اختيارية.

signals
object

إشارات اختيارية للجهاز والشبكة حول المستخدم النهائي، تُمرَّر إلى طبقة مكافحة الاحتيال لتحسين اكتشاف حركة المرور المسيئة أو الآلية. جميع الحقول اختيارية.

vendor_data
string

معرّف اختياري يتحكم فيه المتصل (معرّف المستخدم الداخلي لديك، أو بريد إلكتروني، أو UUID، وما إلى ذلك) يُحفظ في الجلسة ويُعاد في استجابة الإرسال، واستجابة فحص التطابق، وwebhook، وBusiness Console. استخدمه لربط request_id الخاص بـ Didit بسجل المستخدم لديك.

metadata
object | null

كائن JSON اختياري حرّ التنسيق يُحفظ في الجلسة ويُعاد في استجابة الإرسال، واستجابة فحص المطابقة، وwebhooks، وBusiness Console.

الاستجابة

تم تأكيد استلام الإرسال. تحقق من status: تعني Success وRetry أن الرمز في طريقه للإرسال؛ بينما تعني Undeliverable أن العنوان لا يمكنه استلام البريد وأنه قد تم إنهاء التحقق مسبقاً بحالة Declined. تمثل request_id معرف الجلسة المحفوظ (نفس المعرف عند استخدام Retry).

request_id
string<uuid>

معرّف الجلسة لعملية التحقق. يُرجع إرسال Retry نفس قيمة request_id مثل الإرسال الأصلي. يظهر هذا المعرّف في Business Console، ويتم إرجاعه مرة أخرى بواسطة طلب POST /v3/email/check/ مكتمل، ويمكن تمريره إلى GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — تم إرسال OTP عبر البريد الإلكتروني لعملية تحقق جديدة (تتم فوترتها). Retry — تم إرسال OTP جديد عبر البريد الإلكتروني لعملية التحقق المعلقة التي تم إنشاؤها بواسطة إرسال سابق (مجانًا). Undeliverable — فشل العنوان في التحقق من إمكانية التسليم أو تعذر إرسال الرسالة؛ يتم إنهاء عملية التحقق فورًا كـ Declined ولا تتم فوترة أي شيء.

الخيارات المتاحة:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered عندما تكون status هي Undeliverable؛ وnull خلاف ذلك.

الخيارات المتاحة:
email_can_not_be_delivered,
null
vendor_data
string | null

نسخة مطابقة من vendor_data المخزنة في الجلسة (من الإرسال الأول).

metadata
object | null

نسخة مطابقة من metadata المخزنة في الجلسة (من الإرسال الأول).

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