GET/api/v2/messages/policies
قائمة سياسات المزوّدين
يعيد السياسات التي تحدد الأنواع المسموحة لكل مزوّد وقناة (OTP، نص حر، قالب، وغيرها). مفيد قبل بناء واجهة إرسال ديناميكية. يتطلب X-API-Key مع صلاحية messages:create ورقم هاتف موثّق.
متى تستخدمه. عندما يحتاج نظامك معرفة ما يمكن إرساله على كل قناة دون تجربة فاشلة.
مثال الطلب
مثال صحيح: قائمة السياسات
curl --location 'https://raselsms.com/api/v2/messages/policies' \--header 'X-API-Key: YOUR_API_KEY'مثال خاطئ: خطأ: بدون مفتاح
curl --location 'https://raselsms.com/api/v2/messages/policies' \--header 'X-API-Key: YOUR_API_KEY'المسار محمي بـ X-API-Key وصلاحية messages:create.
مثال الاستجابة
200 — قائمة السياسات
{ "success": true, "data": [ { "providerKey": "sms_mtn", "channel": "sms_syria", "enabled": true, "allowedTypes": [ "otp", "utility", "marketing", "free_text" ], "sendModeByType": { "otp": "plain_text", "utility": "template_optional", "marketing": "template_optional", "free_text": "plain_text" }, "requiresApprovedTemplate": false, "supportsUserSender": true, "supportsSystemSenderFallback": true, "priorityOrder": 1, "retryPolicy": { "maxAttempts": 2, "backoffMs": 500 } } ]}401 — خطأ: بدون مفتاح
{ "success": false, "requestId": "msgreq_1739012345678_abc123", "code": "UNAUTHORIZED", "error": "Missing or invalid API key"}المسار محمي بـ X-API-Key وصلاحية messages:create.
403 — الهاتف غير موثّق أو الصلاحية غير كافية (غالباً messages:create أو api_keys:read).
{ "success": false, "requestId": "msgreq_1739012345678_abc123", "code": "FORBIDDEN", "error": "Phone not verified or missing permission"}429 — تم تجاوز حد الطلبات. انتظر Retry-After إن وُجد.
{ "success": false, "requestId": "msgreq_1739012345678_abc123", "code": "RATE_LIMITED", "error": "Rate limit exceeded", "retryAfterSeconds": 30}طلب HTTP
GET /api/v2/messages/policies
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| success | boolean | صحيح عندما ينجح الإجراء، أو عندما ينجح مستلم واحد على الأقل في الدفعة. | |
| data | json | البيانات الأساسية في مسارات القوائم وملخص الحساب. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 401 | مفتاح API مفقود أو غير صالح. |
| 403 | الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
جرّب الطلب
الطلب
GET /api/v2/messages/policiesالاستجابة
نفّذ طلباً لعرض الاستجابة.