تخطَّ إلى المحتوى

القوالب

القالب نص محفوظ للحملات، ويمكن أن يستخدم هذه المتغيرات:

المتغير يُملأ بـ
{{first_name}} الاسم الأول لجهة الاتصال.
{{last_name}} اسم العائلة.
{{custom.<key>}} حقل مخصص، مثل {{custom.branch}}.
{{first_name|there}} أي متغير مع قيمة بديلة بعد | تُستخدم عندما تكون القيمة فارغة، حتى 60 حرفا.

القيمة المفقودة دون بديل تظهر فارغة، وتُدمج المسافة المزدوجة الناتجة. أي شيء آخر بين الأقواس المزدوجة غير صالح. تُحفظ النصوص مشفرة. تنسخ الحملة النص عند إنشائها، فتعديل القالب أو حذفه لا يغير أي حملة.

الحقل النوع الوصف
id string tpl_…
name string فريد داخل مؤسستك.
body string النص مع المتغيرات.
variables string[] المتغيرات المستخدمة، مثل ["first_name", "custom.branch"].
preview object { encoding, segments, characters } للنص بعد ملئه لجهة اتصال نموذجية.
createdAt وupdatedAt string
GET/v1/templatescampaigns:read
الاستعلام النوع الوصف
q string نص يرد في الاسم.
limit integer من 1 إلى 200، والافتراضي 50.
cursor string nextCursor من الصفحة السابقة.
نافذة طرفيّة
curl https://api.smsfabric.com/v1/templates \
-H "X-Api-Key: $SMSFABRIC_API_KEY"
POST/v1/templatescampaigns:manage

يعيد 201. يدعم Idempotency-Key.

حقل المحتوى النوع إلزامي القيود
name string نعم من 1 إلى 120 حرفا، فريد.
body string نعم من 1 إلى 1600 حرف، بمتغيرات صالحة فقط.
نافذة طرفيّة
curl https://api.smsfabric.com/v1/templates \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Winter sale", "body": "Hi {{first_name|there}}, the winter sale starts Friday at {{custom.branch}}. Reply STOP to opt out."}'
{
"id": "tpl_h7k0n3q6t9w2z5c8f1i4l7o0",
"name": "Winter sale",
"body": "Hi {{first_name|there}}, the winter sale starts Friday at {{custom.branch}}. Reply STOP to opt out.",
"variables": ["first_name", "custom.branch"],
"preview": { "encoding": "GSM7", "segments": 1, "characters": 86 },
"createdAt": "2026-11-19T11:20:00.000Z",
"updatedAt": "2026-11-19T11:20:00.000Z"
}
الخطأ متى
400 template_invalid متغير غير معروف، أو أقواس شاردة، أو قيمة بديلة أطول من 60 حرفا. تسرد errors[] كلا منها.
409 template_exists يوجد قالب بهذا الاسم.
POST/v1/templates/previewcampaigns:read

يملأ النص لإحدى جهات اتصالك، أو لجهة اتصال نموذجية. يعيد 200، ولا يعيد 400 أبدا بسبب مشكلات القالب: تعود في issues (unknown_variable أو malformed أو fallback_too_long).

حقل المحتوى النوع إلزامي القيود
body string نعم من 1 إلى 1600 حرف.
contactId string لا جهة اتصال في مؤسستك.
نافذة طرفيّة
curl https://api.smsfabric.com/v1/templates/preview \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"body": "Hi {{first_name}}, your {{custom.tier}} points: {{custom.loyalty_points}}", "contactId": "con_a8d1g4j7m0p3s6v9y2b5e8h1"}'
{
"rendered": "Hi Mona, your points: 1250",
"variables": ["first_name", "custom.tier", "custom.loyalty_points"],
"issues": [],
"segments": { "encoding": "GSM7", "segments": 1, "characters": 26 }
}

يعيد 404 not_found إذا لم تكن contactId في مؤسستك.

GET/v1/templates/:idcampaigns:read
نافذة طرفيّة
curl https://api.smsfabric.com/v1/templates/tpl_h7k0n3q6t9w2z5c8f1i4l7o0 \
-H "X-Api-Key: $SMSFABRIC_API_KEY"
PATCH/v1/templates/:idcampaigns:manage

يقبل name وbody، وكلاهما اختياري بقيود الإنشاء نفسها. يعيد القالب.

نافذة طرفيّة
curl -X PATCH https://api.smsfabric.com/v1/templates/tpl_h7k0n3q6t9w2z5c8f1i4l7o0 \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"body": "Hi {{first_name|there}}, the winter sale starts Thursday. Reply STOP to opt out."}'
DELETE/v1/templates/:idcampaigns:manage

يعيد 204. تحتفظ الحملات التي استخدمته بنسختها من النص.

نافذة طرفيّة
curl -X DELETE https://api.smsfabric.com/v1/templates/tpl_h7k0n3q6t9w2z5c8f1i4l7o0 \
-H "X-Api-Key: $SMSFABRIC_API_KEY"