• التحقق من رمز واتساب

التحقق من رمز واتساب

POST https://app.alaaqat.com/api/verifications/{id}/verify

حيث id هو الحقل verification_id الذي أعادته عملية إرسال رمز تحقق عبر واتساب في الوضع المُدار، أي الإرسال الذي تركت فيه الحقل code فارغاً وتركت لنا توليده.

الإرسال في وضع التمرير لا يصدر له verification_id، فلا يوجد ما يُتحقق منه هنا: إن كنت أرسلت الرمز بنفسك فأنت تملك التحقق منه أيضاً.

يجب أن يحمل المفتاح صلاحية broadcast-send-otp، وهذه الواجهة غير متاحة من جلسة المستخدم (الطرف الأول).

الترويسة

{
    "Accept": "application/json"
}

محتوى الطلب

{
    code: string,
}

الاستجابة

200 عند تطابق الرمز، و 422 فيما عدا ذلك. اعتمد على verified في منطق تطبيقك، واستخدم status فقط لتقرر إن كان يستحق أن تطلب الرمز من العميل مرة أخرى.

{
    "verified": true,
    "status": "verified",
    "attempts_remaining": 5
}

القواعد

• الاستخدام مرة واحدة. بعد نجاح التحقق، أي محاولة تحقق أخرى تعيد failed.
• خمس محاولات. كل رمز خاطئ يستهلك محاولة، والمحاولة الخاطئة الخامسة تُنهي التحقق، فيتوقف حتى الرمز الصحيح عن العمل بعدها.
• الصلاحية تتبع القالب. ينتهي التحقق بعد code_expiration_minutes الخاص بالقالب (٥ دقائق إن لم يكن للقالب تذييل صلاحية)، لأن هذه هي الصيغة التي رآها العميل. والتحقق المنتهي يعيد failed ولا يستهلك محاولة.
• يُلغى بإرسال جديد. إرسال رمز جديد لنفس المستلم على نفس القالب يجعل التحقق السابق failed، فلا يبقى أكثر من رمز واحد فعّال.
• محصور بحسابك. أي verification_id يعود لحساب آخر يُعيد 404، تماماً كالذي لم يوجد أصلاً.

الأخطاء