POST/api/v2/verification/verify
التحقق من الرمز
يتحقق من آخر رمز أُرسل. فضّل verificationId مع code. to مع code مقبول كاحتياط.
طلب HTTP
POST /api/v2/verification/verify
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
جسم الطلب
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| verificationId | string | المعرّف الراجع من خطوة إرسال التحقق. فضّله في إعادة الإرسال والتحقق. | |
| to | string | المستلم: رقم دولي E.164، أو بريد عندما تكون القناة email، أو معرّف مجموعة واتساب، أو معرّف محادثة تلغرام، أو مصفوفة نصوص حتى 100 مستلم للدفعة الرسمية. | |
| code | string | رمز خطأ مقروء آلياً أو رمز التحقق حسب المسار. * | 123456 |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| verificationId | string | المعرّف الراجع من خطوة إرسال التحقق. فضّله في إعادة الإرسال والتحقق. | |
| verified | true | صحيح عندما يطابق الرمز المُرسل. | |
| alreadyVerified | boolean | صحيح عندما كانت المحاولة موثّقة مسبقاً. | |
| verifiedAt | string,null (date-time) | وقت التحقق الناجح. | |
| remainingAttempts | number | null | محاولات التحقق المتبقية، أو null إن لم تنطبق. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 400 | طلب غير صالح، أو خطأ تحقق، أو المورد لا يمكن استخدامه في هذه الحالة. |
| 404 | المورد غير موجود لمالك مفتاح API. |
| 410 | انتهت صلاحية رمز التحقق. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
جرّب الطلب
الاستجابة
نفّذ طلباً لعرض الاستجابة.