قائمة القوالب
بدون officialSenderId يُرجع كل القوالب الظاهرة للحساب. كل صف يتضمن officialSender وisPlatformNumber وheaderType وheaderAssetId وheaderPreviewUrl وallowsHeaderMediaOverride. الفلتر الافتراضي للحالة: active وapproved.
متى تستخدمه. قبل الإرسال بـ template.key أو template.id.
مثال الطلب
مثال صحيح: قوالب واتساب المعتمدة
curl --location 'https://raselsms.com/api/v2/templates' \--header 'X-API-Key: YOUR_API_KEY'مثال الاستجابة
200 — قوالب واتساب المعتمدة
{ "data": [ { "id": "6800tpl123def4567890aaaa", "name": "order_ready_notice", "category": "whatsapp", "subType": "utility", "language": "ar", "status": "approved", "headerType": "image", "headerValue": null, "headerAssetId": null, "headerPreviewUrl": null, "allowsHeaderMediaOverride": true, "provider": "meta", "officialSenderId": "platform", "officialSender": { "id": "platform", "scope": "platform", "isPlatform": true, "isDefault": true, "label": null, "phoneNumber": null, "displayName": "platform" }, "isPlatformNumber": true, "isDefault": false, "createdAt": "2026-09-01T10:00:00.000Z" }, { "id": "6800tpl123def4567890bbbb", "name": "promo_offer", "category": "whatsapp", "subType": "utility", "language": "ar", "status": "approved", "headerType": "image", "headerValue": null, "headerAssetId": null, "headerPreviewUrl": null, "allowsHeaderMediaOverride": true, "provider": "meta", "officialSenderId": "6800abc123def4567890abcd", "officialSender": { "id": "6800abc123def4567890abcd", "scope": "official_sender", "isPlatform": false, "isDefault": false, "label": "SAWA", "phoneNumber": "+963911111111", "displayName": "SAWA · +963911111111" }, "isPlatformNumber": false, "isDefault": false, "createdAt": "2026-09-01T10:00:00.000Z" } ]}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/templates
ترويسات الطلب
| الترويسة | النوع | الوصف |
|---|---|---|
| X-API-Key | string | مفتاح Rasel API. أرسله في كل طلب موثّق ما عدا الويب هوك الوارد. * |
معاملات الاستعلام
| الحقل | النوع | الوصف |
|---|---|---|
| category | whatsapp | sms | message | email | فئة القالب: whatsapp أو sms أو message أو email. |
| status | pending | approved | rejected | active | disabled | حالة التسليم أو السجل. في الإرسال: sent أو queued أو scheduled. في الموارد الأخرى هي فلتر الحالة أو قيمتها. |
| provider | user_session | meta | internal | فلتر أو قيمة مزوّد القالب: user_session أو meta أو internal. |
| officialSenderId | string | معرّف مرسل واتساب الرسمي من /api/v2/official-senders. مرادف sender.officialId. استخدم platform لرقم ميتا الافتراضي عند قائمة القوالب. |
حقول الاستجابة
| الحقل | النوع | الوصف | مثال |
|---|---|---|---|
| data | json | البيانات الأساسية في مسارات القوائم وملخص الحساب. |
رموز الحالة
| الحالة | الوصف |
|---|---|
| 200 | نجاح. |
| 401 | مفتاح API مفقود أو غير صالح. |
| 404 | المورد غير موجود لمالك مفتاح API. |
| 429 | تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى. |
| 403 | الهاتف غير موثّق، أو الصلاحية ناقصة، أو الحساب لا يستطيع تنفيذ هذا الإجراء. |
جرّب الطلب
المتغيرات
فئة القالب: whatsapp أو sms أو message أو email.
حالة التسليم أو السجل. في الإرسال: sent أو queued أو scheduled. في الموارد الأخرى هي فلتر الحالة أو قيمتها.
فلتر أو قيمة مزوّد القالب: user_session أو meta أو internal.
معرّف مرسل واتساب الرسمي من /api/v2/official-senders. مرادف sender.officialId. استخدم platform لرقم ميتا الافتراضي عند قائمة القوالب.
الطلب
GET /api/v2/templates?category=whatsapp&status=pending&provider=user_sessionالاستجابة
نفّذ طلباً لعرض الاستجابة.