POST/api/v2/sms-senders
طلب اسم مرسل SMS جديد
يرسل الاسم لمراجعة الإدارة ويبقى pending. مالك الحساب فقط (أعضاء الفريق لا ينشئون عبر API). يمكن إرفاق webhookUrl وwebhookSecret لإشعار الاعتماد أو الرفض.
طلب HTTP
POST /api/v2/sms-senders
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
جسم الطلب
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| name | string | الاسم الظاهر أو معرّف القالب الإنجليزي الصغير، حسب المسار. * | MyBrand |
| webhookUrl | string | رابط HTTPS لاستقبال حدث الاعتماد أو الرفض. | https://your-system.com/webhooks/rasel/sender-status |
| webhookSecret | string | إلزامي مع webhookUrl. يُرسل Bearer في ردود راسل ولا يُعاد في الاستجابة. | your-long-random-secret |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| success | boolean | صحيح عندما ينجح الإجراء، أو عندما ينجح مستلم واحد على الأقل في الدفعة. | true |
| data | object | الحمولة الأساسية لمسارات القائمة واللقطة. | |
| message | string | رسالة نتيجة مقروءة بعد الإنشاء أو الرفع. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 201 | تم الإنشاء. |
| 400 | طلب غير صالح، أو خطأ تحقق، أو المورد لا يمكن استخدامه في هذه الحالة. |
| 401 | مفتاح API مفقود أو غير صالح. |
| 403 | الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
جرّب الطلب
الاستجابة
نفّذ طلباً لعرض الاستجابة.