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

مرجع الواجهة البرمجية

واجهة SMSFabric البرمجية واجهة REST بصيغة JSON. كل نقاط النهاية في هذه الصفحات عامة ومرقّمة الإصدار تحت /v1.

https://api.smsfabric.com

كل طلب يستخدم HTTPS. محتوى الطلبات والاستجابات JSON بحقول camelCase، عدا ملفات CSV المصدّرة والملفات المرفوعة.

أرسل مفتاح API في الترويسة X-Api-Key:

نافذة طرفيّة
curl https://api.smsfabric.com/v1/devices \
-H "X-Api-Key: sf_test_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

يعرض كل مدخل الصلاحية التي يحتاجها بجانب المسار. المداخل المعلّمة للمستخدمين فقط ترفض مفاتيح API مع 403 api_key_not_allowed، فاستخدم البوابة لها. انظر المصادقة.

الموضوع القاعدة
المعرّفات نصوص ببادئة تدل على النوع: msg_ وevt_ وdev_ وsim_ وpool_ وver_ وcon_ وgrp_ وimp_ وtpl_ وcmp_ وblk_ وkey_ وwhk_ وdlv_ وaud_ وorg_ وusr_.
الأوقات ISO 8601 بتوقيت UTC، مثل 2026-11-19T10:15:02.114Z.
أرقام الهواتف E.164، مثل +201001234567، ويُتحقق منها بمكتبة libphonenumber.
الحقول غير المعروفة تُرفض مع 400 validation_failed.
المؤسسات الأخرى المعرّف الذي يتبع مؤسسة أخرى يعيد 404 not_found، تماما مثل المعرّف غير الموجود.
حجم المحتوى محتوى JSON حتى 100 KB.
الإنشاء طلب POST الذي ينشئ يعيد 201 مع الكائن. الإجراءات تعيد 200 أو 202. وDELETE يعيد 204 دون محتوى.

الأخطاء بصيغة application/problem+json:

{
"type": "https://docs.smsfabric.com/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "Message not found",
"code": "not_found",
"requestId": "req_u7x0a3d6g9j2m5p8s1v4y7b0"
}

كل الرموز مذكورة في الأخطاء.

تقبل نقاط نهاية القوائم limit (من 1 إلى 200، والافتراضي 50) وcursor، وتعيد { "data": [...], "nextCursor": "…" | null }. انظر تقسيم الصفحات.

تقبل نقاط نهاية الإنشاء الترويسة Idempotency-Key (من 1 إلى 255 حرفا من A–Z a–z 0–9 _ - : .). إعادة الطلب بالمفتاح نفسه خلال 24 ساعة تعيد الاستجابة الأصلية مع Idempotent-Replayed: true. انظر منع التكرار.

معدل باقتك لكل مفتاح API (من 60 إلى 6000 طلب في الدقيقة)، و300 لكل مستخدم مسجل الدخول، و600 لكل عنوان IP، و1200 لكل مؤسسة، و20 في الدقيقة للعمليات المجمعة. تحمل الاستجابات RateLimit-Limit وRateLimit-Remaining وRateLimit-Reset. انظر حدود المعدل.

لتجربة نقاط النهاية هذه دون كتابة شيفرة، استورد مجموعة جاهزة. تشرح صفحة Postman وInsomnia الاستيراد والمتغيرات.

22 طلبًا جاهزًا بالترتيب الذي تجربها به، من أول إرسال إلى الحملات وخطافات الويب وباقتك.

المورد نقاط النهاية
الرسائل الإرسال والعرض والقراءة والإحصاءات والتصدير بصيغة CSV.
عمليات التحقق رموز لمرة واحدة وإعدادات حمايتها.
الأجهزة الهواتف المقترنة وشرائحها ورموز الإقران.
مجموعات الأجهزة مجموعات هواتف بالتناوب والتحويل عند التعطل.
جهات الاتصال من ترسل إليهم، مع الوسوم والحقول المخصصة والموافقة.
مجموعات جهات الاتصال قوائم ثابتة من جهات الاتصال.
استيراد جهات الاتصال استيراد CSV على خطوتين.
القوالب نصوص قابلة لإعادة الاستخدام بمتغيرات.
الحملات إرسال جماعي بسرعة مضبوطة وساعات هدوء وتقارير.
القائمة السوداء أرقام لا تصلها رسائل أبدا.
مفاتيح API إنشاء المفاتيح وتدويرها وإلغاؤها.
Webhooks نقاط النهاية والطلبات وإعادة الإرسال والاختبار.
المؤسسة ملف المؤسسة والأعضاء والدعوات.
الباقات قائمة الأسعار، وباقتك وحدودها واستخدامها.
التفضيلات السرعة والشريحة الافتراضية ونافذة الإرسال والتحويل والمنطقة الزمنية.
سجل التدقيق أحداث الأمان والإعدادات.
الحالة الصحية حالة الخدمة.