GET/api/v2/sms-senders
قائمة أسماء مرسلي SMS
أسماء المرسل المرتبطة بالحساب. استخدم approvedOnly=true قبل الإرسال عبر /api/v2/messages/send.
متى تستخدمه. اختيار sender.id في طلب الإرسال.
مثال الطلب
مثال صحيح: المعتمدون فقط
curl --location 'https://raselsms.com/api/v2/sms-senders' \--header 'X-API-Key: YOUR_API_KEY'مثال الاستجابة
200 — المعتمدون فقط
{ "success": true, "data": { "smsSenders": [ { "id": "6800abc123def4567890fedc", "name": "MyBrand", "status": "approved", "isDefault": true, "reviewNote": null } ] }}401 — مفتاح API مفقود أو غير صالح.
{ "success": false, "requestId": "msgreq_1739012345678_abc123", "code": "UNAUTHORIZED", "error": "Missing or invalid API key"}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/sms-senders
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
معاملات الاستعلام
| الحقل | النوع | الوصف |
|---|---|---|
| approvedOnly | boolean | عند true تُعاد الصفوف المعتمدة فقط (وللمرسلين الرسميين المفعّلون). |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| success | boolean | صحيح عندما ينجح الإجراء، أو عندما ينجح مستلم واحد على الأقل في الدفعة. | |
| data | object | البيانات الأساسية في مسارات القوائم وملخص الحساب. | |
| data.smsSenders | json | أسماء مرسل SMS المعتمدة على هذا الحساب. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 401 | مفتاح API مفقود أو غير صالح. |
| 403 | الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
جرّب الطلب
المتغيرات
عند true تُعاد الصفوف المعتمدة فقط (وللمرسلين الرسميين المفعّلون).
الطلب
GET /api/v2/sms-sendersالاستجابة
نفّذ طلباً لعرض الاستجابة.