POST/api/v2/verification/send
إرسال رمز تحقق
ينشئ محاولة user_verification جديدة، يلغي أي رمز نشط سابق لنفس الرقم، ويرسل رمزاً مولَّداً. لا تستخدم messages/send إذا كنت تحتاج دورة تحقق كاملة.
طلب HTTP
POST /api/v2/verification/send
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
| Idempotency-Key | string | مفتاح اختياري فريد لإعادة المحاولة الآمنة. يتقدّم على idempotencyKey في الجسم. يمكن إعادة نفس الاستجابة لمدة 24 ساعة عند تفعيل خاصية Idempotency. |
جسم الطلب
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| to | string | المستلم: رقم دولي E.164، أو بريد عندما تكون القناة email، أو معرّف مجموعة واتساب، أو معرّف محادثة تلغرام، أو مصفوفة نصوص حتى 100 مستلم للدفعة الرسمية. * | +963912345678 |
| channel | int_sms | local_sms | user_whatsapp_session | system_whatsapp_sessions | official_whatsapp | telegram_otp | official_whatsapp_otp | قناة التسليم. في الإرسال الموحّد فضّل auto أو local_sms أو int_sms أو official_whatsapp أو جلسات واتساب ويب أو telegram_bot أو email_user. في التحقق احذف الحقل للاختيار التلقائي، ولا ترسل sms أو whatsapp أو auto وحدها. | |
| senderId | string | معرّف مرسل SMS معتمد. إن حُذف يُستخدم الافتراضي ثم مرسل المنصة. | |
| officialSenderId | string | معرّف مرسل واتساب الرسمي من /api/v2/official-senders. مرادف sender.officialId. استخدم platform لرقم ميتا الافتراضي عند قائمة القوالب. | |
| sender | object | تجاوز اختياري للمرسل. إن حُذف يستخدم رسيل المرسل المعتمد الافتراضي ثم مرسل المنصة. | |
| idempotencyKey | string | بديل اختياري في الجسم لترويسة Idempotency-Key. فضّل الترويسة. |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| verificationId | string | المعرّف الراجع من خطوة إرسال التحقق. فضّله في إعادة الإرسال والتحقق. | |
| status | sent | حالة التسليم أو السجل. في الإرسال: sent أو queued أو scheduled. في الموارد الأخرى هي فلتر الحالة أو قيمتها. | |
| channel | string | null | قناة التسليم. في الإرسال الموحّد فضّل auto أو local_sms أو int_sms أو official_whatsapp أو جلسات واتساب ويب أو telegram_bot أو email_user. في التحقق احذف الحقل للاختيار التلقائي، ولا ترسل sms أو whatsapp أو auto وحدها. | |
| channels | string[] | أسماء القنوات العامة عندما ينجح التوزيع على أكثر من قناة متوافقة. | |
| deliveries | object[] | تتبع لكل قناة عند تفعيل التوزيع. | |
| expiresAt | string (date-time) | وقت انتهاء رمز التحقق الحالي. | |
| resendAvailableAt | string (date-time) | أقرب وقت يُسمح فيه بإعادة الإرسال. | |
| resendCount | number | عدد مرات إعادة إرسال الرمز. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 400 | طلب غير صالح، أو خطأ تحقق، أو المورد لا يمكن استخدامه في هذه الحالة. |
| 401 | مفتاح API مفقود أو غير صالح. |
| 403 | الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء. |
| 409 | تعارض، مثل إعادة استخدام مفتاح Idempotency بجسم مختلف، أو جلسة غير جاهزة. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
جرّب الطلب
قد يخصم هذا الطلب من رصيد المحفظة أو حصة الباقة.
الاستجابة
نفّذ طلباً لعرض الاستجابة.