صفوف مهمة الإرسال الجماعي
صفحة من 50 صفاً لصاحب الحساب. cursor هو رقم الصف ويبدأ من الصفر. nextCursor يساوي null في الصفحة الأخيرة. يظهر نص الرسالة ومتغيرات القالب ولا تظهر بايتات الملفات. status غير المعروف يعيد صفحة فارغة.
متى تستخدمه. عرض المستلم والقناة والمرسل والقالب والنص ورمز الخطأ صفاً صفاً.
مثال الطلب
مثال صحيح: صحيح: الصفوف الفاشلة
curl --location 'https://raselsms.com/api/v2/messages/bulk/64b0c0ff0000000000000001/items?status=failed&cursor=0' \--header 'X-API-Key: YOUR_API_KEY'مثال الاستجابة
200 — صحيح: الصفوف الفاشلة
{ "success": true, "items": [ { "index": 0, "status": "failed", "to": "+963912345678", "channel": "local_sms", "senderId": "", "templateName": "", "text": "Example notice from Rasel.", "variables": null, "errorCode": "SEND_FAILED", "errorMessage": "Send failed", "requestId": null } ], "nextCursor": null}200 — صفحة صفوف. received مخزّن ولم يُفحص. pending جاهز. sending محجوز. sent مقبول. failed هذا الصف فقط. cancelled لم يُرسَل.
{ "success": true, "items": [], "nextCursor": null}404 — لا توجد مهمة بهذا المعرّف لهذا الحساب. الرمز JOB_NOT_FOUND.
{ "success": false, "code": "JOB_NOT_FOUND", "error": "Job was not found"}401 — مفتاح API مفقود أو غير صالح.
{ "success": false, "requestId": "msgreq_1739012345678_abc123", "code": "UNAUTHORIZED", "error": "Missing or invalid API key"}403 — الهاتف غير موثّق أو تنقص صلاحية messages:read. الرمز FORBIDDEN.
{ "success": false, "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/bulk/{jobId}/items
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
معاملات المسار
| الحقل | النوع | الوصف |
|---|---|---|
| jobId | string | معرّف المهمة من رد الإنشاء. المهمة ظاهرة لصاحب المفتاح فقط. * |
معاملات الاستعلام
| الحقل | النوع | الوصف |
|---|---|---|
| status | received | pending | sending | sent | failed | cancelled | حالة التسليم أو السجل. في الإرسال: sent أو queued أو scheduled. في الموارد الأخرى هي فلتر الحالة أو قيمتها. |
| cursor | integer | مؤشر ترقيم غير شفاف من الاستجابة السابقة. |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| success | enum | صحيح عندما ينجح الإجراء، أو عندما ينجح مستلم واحد على الأقل في الدفعة. * | |
| items | json | صفحة الصفوف. كل عنصر مستلم واحد بحالته ونصه إن كان المسار يعيد النص. * | |
| nextCursor | integer | مؤشر الصفحة التالية. null يعني أن هذه آخر صفحة. أعده كما هو في الطلب التالي. * |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 401 | مفتاح API مفقود أو غير صالح. |
| 403 | الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء. |
| 404 | المورد غير موجود لمالك مفتاح API. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
حالات يجب أن تعرفها
- نص الرسالة يظهر لصاحب الحساب عبر هذا المسار فقط. لا تسجّل النص إن كان يحتوي رمزاً سرياً.
جرّب الطلب
المتغيرات
معرّف المهمة من رد الإنشاء. المهمة ظاهرة لصاحب المفتاح فقط.
حالة التسليم أو السجل. في الإرسال: sent أو queued أو scheduled. في الموارد الأخرى هي فلتر الحالة أو قيمتها.
مؤشر ترقيم غير شفاف من الاستجابة السابقة.
الطلب
GET /api/v2/messages/bulk//items?status=receivedالاستجابة
نفّذ طلباً لعرض الاستجابة.