Rasel / Docs
AR
GET/api/v2/official-senders

قائمة مرسلين واتساب الرسميين

أرقام واتساب الرسمية المعتمدة لمالك مفتاح API. استخدم officialSenderId أو sender.officialId عند الإرسال. approvedOnly=true يعيد المرسلين المفعّلين فقط.

متى تستخدمه. اختيار officialSenderId أو sender.officialId.

مثال الطلب

مثال صحيح: المرسلون الجاهزون للإرسال

curl --location 'https://raselsms.com/api/v2/official-senders' \--header 'X-API-Key: YOUR_API_KEY'

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

200 — المرسلون الجاهزون للإرسال

{  "success": true,  "data": {    "officialSenders": [      {        "id": "6800off123def4567890aaaa",        "label": "SAWA",        "displayName": "SAWA · 9613284927",        "phoneNumber": "+9613284927",        "status": "approved",        "enabled": true,        "isDefault": true,        "verifiedName": "SAWA"      }    ]  }}

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/official-senders

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

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

معاملات الاستعلام

الحقلالنوعالوصف
approvedOnlybooleanعند true تُعاد الصفوف المعتمدة فقط (وللمرسلين الرسميين المفعّلون).

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

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

رموز الحالة

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

جرّب الطلب

المتغيرات

عند true تُعاد الصفوف المعتمدة فقط (وللمرسلين الرسميين المفعّلون).

الطلب

GET /api/v2/official-senders

الاستجابة

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