Rasel / Docs
AR
POST/api/v2/sms-senders

طلب اسم مرسل SMS جديد

يرسل الاسم لمراجعة الإدارة ويبقى pending. مالك الحساب فقط (أعضاء الفريق لا ينشئون عبر API). يمكن إرفاق webhookUrl وwebhookSecret لإشعار الاعتماد أو الرفض.

متى تستخدمه. عندما يحتاج نظامك اسم مرسل جديداً قبل الحملات.

مثال الطلب

مثال صحيح: طلب اسم جديد

curl --location 'https://raselsms.com/api/v2/sms-senders' \--header 'X-API-Key: YOUR_API_KEY' \--header 'Content-Type: application/json' \--data '{"name":"MyBrand","webhookUrl":"https://your-system.com/webhooks/rasel/sender-status","webhookSecret":"your-long-random-secret"}'

مثال خاطئ: خطأ: اسم مكرر

curl --location 'https://raselsms.com/api/v2/sms-senders' \--header 'X-API-Key: YOUR_API_KEY' \--header 'Content-Type: application/json' \--data '{"name":"MyBrand"}'

الاسم يجب أن يكون فريداً داخل الحساب.

مثال الاستجابة

201 — طلب اسم جديد

{  "success": true,  "message": "Sender submitted for review",  "data": {    "smsSender": {      "id": "6800abc123def4567890fedc",      "name": "MyBrand",      "status": "pending",      "isDefault": false,      "webhookConfigured": true    }  }}

400 — خطأ: اسم مكرر

{  "success": false,  "code": "VALIDATION_ERROR",  "error": "Sender name already exists"}

الاسم يجب أن يكون فريداً داخل الحساب.

401 — مفتاح غير صالح.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "UNAUTHORIZED",  "error": "Missing or invalid API key"}

طلب HTTP

POST /api/v2/sms-senders

ترويسات الطلب

الترويسةالنوعالوصف
X-API-Keystringمفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. *

جسم الطلب

الحقلالنوعالوصفمثال
namestringالاسم الظاهر أو معرّف القالب الإنجليزي الصغير، حسب المسار. *
webhookUrlstringرابط HTTPS لاستقبال حدث الاعتماد أو الرفض.
webhookSecretstringإلزامي مع webhookUrl. يُرسل Bearer في ردود راسل ولا يُعاد في الاستجابة.

حقول الاستجابة

الحقلالنوعالوصفمثال
successbooleanصحيح عندما ينجح الإجراء، أو عندما ينجح مستلم واحد على الأقل في الدفعة.
dataobjectالبيانات الأساسية في مسارات القوائم وملخص الحساب.
data.smsSenderstringاسم مرسل SMS الذي أُنشئ أو أُعيد.
messagestringرسالة نتيجة مقروءة بعد الإنشاء أو الرفع.

رموز الحالة

الحالةالوصف
201تم الإنشاء.
400طلب غير صالح، أو خطأ تحقق، أو المورد لا يمكن استخدامه في هذه الحالة.
401مفتاح API مفقود أو غير صالح.
403الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء.
429تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى.

حالات يجب أن تعرفها

  • رد الويب هوك: Authorization: Bearer <secret> و X-Rasel-Event: sms_sender.approved | sms_sender.rejected.

جرّب الطلب

المتغيرات

الاسم الظاهر أو معرّف القالب الإنجليزي الصغير، حسب المسار.

رابط HTTPS لاستقبال حدث الاعتماد أو الرفض.

إلزامي مع webhookUrl. يُرسل Bearer في ردود راسل ولا يُعاد في الاستجابة.

الطلب

{}

الاستجابة

نفّذ طلباً لعرض الاستجابة.