الانتقال إلى المحتوى الرئيسي
POST
curl
تُجري المعاينة ولا تغيّر شيئاً ولا ترسل شيئاً. تعرض الاستجابة البريد الإلكتروني كما يستلمه الشخص تماماً عند تعيين الجلسة إلى Approved أو Declined مع send_email: true. كما تُبيّن لك من سيستلمه، ومن مُرسله، وما إذا كان تأكيد التغيير سيرسله أصلاً.

من يستلم البريد الإلكتروني

يُرسَل البريد الإلكتروني إلى عنوان الشخص نفسه، وهو العنوان الذي تحقق منه في خطوة التحقق من البريد الإلكتروني ضمن التدفق، وإلا فالعنوان المذكور في contact_details عند إنشاء الجلسة. يحدد recipient_source المصدر المستخدَم (email_verification أو contact_details). عندما لا يتوفر عنوان بريد إلكتروني للشخص في الجلسة، تكون قيم recipient وrecipient_source وpreview_token سلاسل نصية فارغة، ولا يمكن إرسال أي بريد إلكتروني. يُرسَل البريد الإلكتروني من نطاق المرسل المُتحقَّق منه في تطبيقك عندما ينطبق إعداد العلامة البيضاء الخاص بك (sender_kind: customer)، وإلا فمن مرسل Didit (sender_kind: didit).

هل سيُرسَل البريد الإلكتروني

تكون قيمة will_be_sent مساوية لـ true عندما يؤدي تأكيد التغيير مع send_email: true إلى إرسال البريد الإلكتروني. عندما تكون القيمة false، يوضح not_sent_reason السبب:

تأكيد القرار

استدعِ تحديث حالة الجلسة مع هذه الحقول: تنتهي صلاحية الإيصال بعد 15 دقيقة. إذا تغيّر المستلم أو اللغة أو حالة الجلسة أو المرسل أو البريد الإلكتروني منذ المعاينة، يعيد التحديث الاستجابة 409 قبل إجراء أي تغيير. أعِد المعاينة وأكِّد بالإيصال الجديد.

مواضيع ذات صلة

التفويضات

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.

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

sessionId
string<uuid>
مطلوب

معرّف UUID لجلسة التحقق. يقبل معرّفات جلسات المستخدمين (KYC) والشركات (KYB).

مثال:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

الجسم

application/json
new_status
enum<string>
مطلوب

القرار الذي تريد معاينة بريده الإلكتروني.

الخيارات المتاحة:
Approved,
Declined
مثال:

"Approved"

email_language
string
افتراضي:en

لغة البريد الإلكتروني، بنفس القيمة الافتراضية مثل تحديث حالة الجلسة. اللغة غير المتوفرة تعود تلقائياً إلى الإنجليزية؛ يحدد الحقل language في الاستجابة اللغة المستخدمة.

مثال:

"en"

الاستجابة

معاينة فقط. تظل الجلسة دون تغيير ولا يتم إرسال أي بريد إلكتروني.

recipient
string
مطلوب

العنوان الذي يُرسل إليه البريد الإلكتروني. سلسلة فارغة عند عدم معرفة أي عنوان للشخص: وعندئذٍ لا يمكن إرسال بريد إلكتروني ويكون preview_token فارغاً أيضاً. مرّره كـ email_address عند التأكيد.

مثال:

"person@example.com"

recipient_source
enum<string>
مطلوب

مصدر recipient. القيمة email_verification: العنوان الذي تحقق منه الشخص في خطوة التحقق من البريد الإلكتروني في سير العمل. القيمة contact_details: العنوان المقدَّم في contact_details عند إنشاء الجلسة. سلسلة نصية فارغة في حال عدم وجود عنوان.

الخيارات المتاحة:
email_verification,
contact_details,
مثال:

"email_verification"

sender
string
مطلوب

رأس From الذي يرسل به البريد الإلكتروني.

مثال:

"Example App <no-reply@mail.example.com>"

sender_name
string
مطلوب

جزء الاسم المعروض من sender.

مثال:

"Example App"

sender_email
string<email>
مطلوب

جزء العنوان من sender.

مثال:

"no-reply@mail.example.com"

sender_kind
enum<string>
مطلوب

customer: يخرج البريد الإلكتروني من نطاق الإرسال المعتمد لتطبيقك (العلامة البيضاء). didit: يخرج من مُرسِل Didit نفسه.

الخيارات المتاحة:
customer,
didit
مثال:

"customer"

subject
string
مطلوب

سطر الموضوع تماماً كما تم إرساله.

مثال:

"Your verification has been approved in Example App"

html
string
مطلوب

كود HTML الخاص بالبريد الإلكتروني تماماً كما يُرسل، مع تضمين شعاره كـ data URL. اعرضه داخل إطار معزول، وتجنب تماماً عرضه مباشرة في DOM الخاص بتطبيقك.

مثال:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
مطلوب

كلمات البريد الإلكتروني كنص عادي، كما يحتفظ بها تسلسل رسائل الشخص، للحصول على معاينة موجزة (يظل كود HTML هو البريد الإلكتروني الفعلي الذي يستلمه الشخص).

مثال:

"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."

language
string
مطلوب

اللغة المكتوب بها البريد الإلكتروني. تكون الإنجليزية (en) عندما لا تتوفر email_language التي طلبتها.

مثال:

"en"

will_be_sent
boolean
مطلوب

ما إذا كان تأكيد التغيير باستخدام send_email: true يرسل هذا البريد الإلكتروني. false عندما يكون not_sent_reason معيناً.

مثال:

true

not_sent_reason
enum<string> | null
مطلوب

سبب عدم إرسال أي بريد إلكتروني عند التأكيد، أو null عند إرساله. status_unchanged: تمتلك الجلسة هذه الحالة بالفعل، لذا فإن التحديث لا يغير شيئاً ولا يرسل شيئاً. notification_emails_disabled: تم إنشاء الجلسة دون contact_details.send_notification_emails: true، لذا لن يُرسل أي بريد إلكتروني خاص بالقرار إلى العنوان المحدد في contact_details. no_recipient: لا يوجد عنوان معروف للشخص. sandbox: جلسة بيئة تجريبية لم يشترك مستلمها في تسليم رسائل البريد الإلكتروني للبيئة التجريبية، لذا فإن الإرسال يتم بشكل محاكاة فقط.

الخيارات المتاحة:
status_unchanged,
notification_emails_disabled,
no_recipient,
sandbox,
null
مثال:

null

preview_token
string
مطلوب

إيصال موقّع لرسالة البريد الإلكتروني هذه تحديداً، صالح لمدة 15 دقيقة. مرّره كـ email_preview_token إلى تحديث حالة الجلسة. سلسلة فارغة في حال عدم وجود مستلم.

مثال:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

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