GET/api/v2/templates/{id}

قالب واحد حسب المعرّف

يعيد قالباً بالمعرّف id من قائمة القوالب. يجب أن تملكه أو أن يكون قالباً افتراضياً. الرد يتضمن officialSender وisPlatformNumber وheaderType وallowsHeaderMediaOverride.

متى تستخدمه. قراءة الحالة أو معرفة رقم المرسل بعد الإنشاء.

مثال الطلب

مثال صحيح: قراءة قالب

curl --location 'https://raselsms.com/api/v2/templates/6800tpl123def4567890aaaa' \--header 'X-API-Key: YOUR_API_KEY'

مثال خاطئ: خطأ: قالب غير موجود

curl --location 'https://raselsms.com/api/v2/templates/000000000000000000000000' \--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"  }}

404 — خطأ: قالب غير موجود

{  "success": false,  "code": "NOT_FOUND",  "error": "Template not found"}

المعرّف يجب أن يخص الحساب أو قالباً افتراضياً.

401 — مفتاح غير صالح.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "UNAUTHORIZED",  "error": "Missing or invalid API key"}

طلب HTTP

GET /api/v2/templates/{id}

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

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

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

الحقل	النوع	الوصف
id	string	معرّف المورد. *

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

الحقل	النوع	الوصف
data	object	البيانات الأساسية في مسارات القوائم وملخص الحساب.
data.id	string	معرّف المورد.
data.name	string	الاسم الظاهر أو معرّف القالب الإنجليزي الصغير، حسب المسار.
data.category	enum	فئة القالب: whatsapp أو sms أو message أو email.
data.subType	enum	النوع الفرعي مثل utility أو otp أو marketing أو free.
data.status	enum	حالة التسليم أو السجل. في الإرسال: sent أو queued أو scheduled. في الموارد الأخرى هي فلتر الحالة أو قيمتها.
data.language	string	لغة قالب ميتا مثل ar أو en. تُستخدم لقوالب واتساب الرسمية.
data.body	string	متن قالب واتساب مع عناصر نائبة مرقمة. اربطه بـ bodyParameters عند الإنشاء وvariablesIndexed عند الإرسال.
data.bodyParameters	json	قيم أمثلة تُرسل إلى ميتا للعناصر النائبة المرقمة في المتن.
data.headerType	enum	نوع الهيدر: text أو image أو video أو document.
data.headerValue	string	قيمة الهيدر النصي عندما يكون headerType هو text.
data.headerAssetId	string	المعرّف من مسار رفع الوسائط. غير مطلوب إذا أُرسل headerMedia أو file أو headerMediaUrl.
data.headerPreviewUrl	string	رابط معاينة لوسائط الهيدر المخزّنة.
data.allowsHeaderMediaOverride	boolean	صحيح عندما يقبل هذا القالب الرسمي هيدر ملف أو رابط لكل إرسال.
data.footer	string	تذييل واتساب اختياري. لا يُستخدم في قوالب جلسة واتساب ويب.
data.buttons	json	أزرار واتساب المضبوطة على القالب.
data.urlButtonVariables	json	قيم لواحق أزرار الرابط في هذا القالب.
data.indexedPlaceholders	string-list	متغيرات المتن المرقمة، مثل {{1}}.
data.content	string	في الإرسال الموحّد: كائن المحتوى (نص أو رمز OTP أو موضوع البريد). في القوالب: متن SMS أو الرسالة، أو HTML/نص البريد.
data.parameters	json	القيم التجريبية أو المرتبطة لمتغيرات متن القالب.
data.provider	string	فلتر أو قيمة مزوّد القالب: user_session أو meta أو internal.
data.providerTemplateId	string	معرّف قالب واتساب الرسمي / ميتا عند الربط اليدوي.
data.manualProvider	enum	المزوّد المسجّل عند ربط هذا القالب يدوياً.
data.officialSenderId	string	معرّف مرسل واتساب الرسمي من /api/v2/official-senders. مرادف sender.officialId. استخدم platform لرقم ميتا الافتراضي عند قائمة القوالب.
data.officialSender	object	رقم واتساب الرسمي المرتبط بهذا القالب.
data.officialSender.id	string	معرّف المورد.
data.officialSender.scope	enum	platform عند استخدام الرقم الافتراضي، وإلا مرسل محدد.
data.officialSender.isPlatform	boolean	صحيح عندما يستخدم القالب الرقم الافتراضي للمنصة.
data.officialSender.isDefault	boolean	صحيح عندما يكون هذا المرسل أو القالب هو الافتراضي للحساب.
data.officialSender.label	string	تسمية المرسل الجاهزة للعرض تجمع الاسم والرقم.
data.officialSender.phoneNumber	string	الرقم الظاهر الموثّق بصيغة E.164.
data.officialSender.displayName	string	الاسم الظاهر لمرسل واتساب الرسمي.
data.isPlatformNumber	boolean	صحيح عندما يكون القالب مرتبطاً برقم المنصة الرسمي الافتراضي.
data.isDefault	boolean	صحيح عندما يكون هذا المرسل أو القالب هو الافتراضي للحساب.
data.createdAt	string	وقت الإنشاء.

رموز الحالة

الحالة	الوصف
200	نجاح.
401	مفتاح API مفقود أو غير صالح.
404	المورد غير موجود لمالك مفتاح API.
429	تم تجاوز حد المعدل، أو وصل عدد محاولات التحقق إلى الحد الأقصى.

جرّب الطلب

مفتاح الـ API

المتغيرات

id*

معرّف المورد.

الطلب

GET /api/v2/templates/6800tpl123def4567890aaaa

الاستجابة

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