POST/api/v2/verification/verify
التحقق من الرمز
يتحقق من آخر رمز أُرسل. فضّل verificationId مع code. to مع code مقبول كاحتياط.
متى تستخدمه. بعد أن يدخل المستخدم الرمز في تطبيقك.
مثال الطلب
مثال صحيح: تحقق صحيح
curl --location 'https://raselsms.com/api/v2/verification/verify' \--header 'X-API-Key: YOUR_API_KEY' \--header 'Content-Type: application/json' \--data '{"verificationId":"6800abc123def4567890fedc","code":"123456"}'مثال خاطئ: خطأ: رمز خاطئ
curl --location 'https://raselsms.com/api/v2/verification/verify' \--header 'X-API-Key: YOUR_API_KEY' \--header 'Content-Type: application/json' \--data '{"verificationId":"6800abc123def4567890fedc","code":"000000"}'كل محاولة فاشلة تنقص remainingAttempts حتى القفل.
مثال الاستجابة
200 — تحقق صحيح
{ "verificationId": "6800abc123def4567890fedc", "verified": true, "alreadyVerified": false, "verifiedAt": "2026-09-05T10:02:11.000Z", "remainingAttempts": null}400 — خطأ: رمز خاطئ
{ "success": false, "code": "VERIFICATION_INVALID_CODE", "error": "Invalid verification code", "verificationId": "6800abc123def4567890fedc", "verified": false, "remainingAttempts": 2}كل محاولة فاشلة تنقص remainingAttempts حتى القفل.
401 — مفتاح غير صالح.
{ "success": false, "requestId": "msgreq_1739012345678_abc123", "code": "UNAUTHORIZED", "error": "Missing or invalid API key"}طلب HTTP
POST /api/v2/verification/verify
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
جسم الطلب
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| verificationId | string | المعرّف الراجع من خطوة إرسال التحقق. فضّله في إعادة الإرسال والتحقق. | |
| to | string | المستلم: رقم دولي E.164، أو بريد عندما تكون القناة email، أو معرّف مجموعة واتساب، أو معرّف محادثة تلغرام، أو مصفوفة نصوص حتى 100 مستلم للدفعة الرسمية. | |
| code | string | رمز خطأ مقروء آلياً أو رمز التحقق حسب المسار. * |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| verificationId | string | المعرّف الراجع من خطوة إرسال التحقق. فضّله في إعادة الإرسال والتحقق. | |
| verified | enum | صحيح عندما يطابق الرمز المُرسل. | |
| alreadyVerified | boolean | صحيح عندما كانت المحاولة موثّقة مسبقاً. | |
| verifiedAt | string | وقت التحقق الناجح. | |
| remainingAttempts | number | محاولات التحقق المتبقية، أو null إن لم تنطبق. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 400 | طلب غير صالح، أو خطأ تحقق، أو المورد لا يمكن استخدامه في هذه الحالة. |
| 404 | المورد غير موجود لمالك مفتاح API. |
| 410 | انتهت صلاحية رمز التحقق. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
| 401 | مفتاح API مفقود أو غير صالح. |
حالات يجب أن تعرفها
- أكواد الخطأ: VERIFICATION_NOT_FOUND, VERIFICATION_EXPIRED, VERIFICATION_INVALID_CODE, VERIFICATION_MAX_ATTEMPTS_EXCEEDED, VERIFICATION_RESEND_COOLDOWN, VERIFICATION_MAX_RESENDS_EXCEEDED, VERIFICATION_CHANNEL_NOT_AVAILABLE.
جرّب الطلب
المتغيرات
المستلم: رقم دولي E.164، أو بريد عندما تكون القناة email، أو معرّف مجموعة واتساب، أو معرّف محادثة تلغرام، أو مصفوفة نصوص حتى 100 مستلم للدفعة الرسمية.
المعرّف الراجع من خطوة إرسال التحقق. فضّله في إعادة الإرسال والتحقق.
رمز خطأ مقروء آلياً أو رمز التحقق حسب المسار.
الطلب
{}الاستجابة
نفّذ طلباً لعرض الاستجابة.