انتقل للمحتوى

    عربي أو إنجليزي · ↑↓ للتنقل · Enter للفتح · Esc للقفل

    English
    في الصفحة دي

    أكواد التحقق (OTP)

    التحقق من الكود

    POST/v2/otp/{otpId}/verify
    • الصلاحية:otp
    • Idempotency-Key:مش مستخدم
    • بيصرف رصيد

    كل محاولة بتتحسب؛ ابعت الكود كنص. reason: INVALID_CODE | EXPIRED | TOO_MANY_ATTEMPTS | ALREADY_VERIFIED.

    البارامترات

    المسار

    الاسمالنوعالقيودالوصف
    otpIdإجباريالنوعstringالقيود—الوصفotpId اللي رجع من POST /v2/otp.

    الهيدرز

    الاسمالنوعالقيودالوصف
    X-Request-Idاختياريالنوعstringالقيود—الوصفاختياري: id الطلب بتاعك وبيرجعلك (غير كده بنعمل req_…). اديه للدعم لو احتجت.

    الـ Body

    الاسمالنوعالقيودالوصف
    codeإجباريالنوعstringالقيود—الوصفالكود اللي الشخص كتبه، كنص (عشان الأصفار اللي في الأول).

    الطلب

    curl -X POST "https://mursilat.com/api/v2/otp/otp_8f2c1d9a7b3e4f56a1b2c3d4/verify" \
      -H "Authorization: Bearer $WASLA_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
      "code": "048213"
    }'
    الطلب — JSON
    {
      "code": "048213"
    }

    الرد

    200مثال

    200 — application/json
    {
      "otpId": "otp_8f2c1d9a7b3e4f56a1b2c3d4",
      "valid": true,
      "reason": null,
      "attemptsLeft": 4
    }

    شكل الرد

    حقول الرد في المثال. افتح الكائنات والقوايم.

    • responseobject4 حقل
      • otpIdstring "otp_8f2c1d9a7b3e4f56a1b2c3d4"
      • validboolean true
      • reasonnull null
      • attemptsLeftinteger 4

    الأخطاء

    غير أخطاء المصادقة وحدود الطلبات والتحقق اللي ممكن ترجع من أي endpoint:

    الأخطاء →

    جرّب

    ابعت الطلب ده من متصفحك لـ API مرسلات.

    مثال موثّق

    معاينة — النسخة دي من التوثيق مش على mursilat.com، فالكونسول بيعرض المثال الموثّق بدل ما يكلم الـ API.

    الطلبات الحقيقية بتستخدم رقمك وباقتك الحقيقيين: ممكن تبعت رسايل واتساب وتصرف من رصيدك وتمسح بيانات. (بيصرف رصيد)

    متخزن في ذاكرة التبويب ده بس: عمره ما بيتحفظ ولا بيتحط في الرابط، وبيتبعت لـ mursilat.com بس. لو عملت reload بيتنسي.

    بارامترات المسار

    تبعت الطلب ده بجد؟

    ده بيصرف من رصيد باقتك.

    POST /v2/otp/{otpId}/verify