حزمة Node
@smsfabric/sdk هي حزمة Node.js الرسمية لواجهة SMSFabric البرمجية. تغلّف كل نقطة نهاية متاحة للعملاء في دالة ذات أنواع محددة، وتعيد المحاولة في الطلبات التي تصح إعادتها، وتتحقق من توقيع خطافات الويب (webhooks) باستدعاء واحد.
- طلبات واستجابات بأنواع TypeScript، مكتوبة وفق مرجع الواجهة البرمجية.
- نسختان ESM وCommonJS مع ملفات الأنواع، ولا تعتمد على أي حزمة أخرى وقت التشغيل.
- تعيد المحاولة عند
429و5xxوأخطاء الشبكة، مع انتظار متزايد يحترم ترويسةRetry-After. - كل عملية إنشاء ترسل
Idempotency-Key، فلا تؤدي إعادة المحاولة التلقائية إلى إرسال مكرر. - تتطلب Node.js 20 أو أحدث، وتستخدم
fetchوFormDataوnode:cryptoالمدمجة.
التثبيت
Section titled “التثبيت”npm install @smsfabric/sdkpnpm add @smsfabric/sdkyarn add @smsfabric/sdkأرسل رسالتك الأولى
Section titled “أرسل رسالتك الأولى”أنشئ مفتاح API بالنطاق messages:send من المطورون ← مفاتيح API في البوابة (الشرح خطوة بخطوة). ابدأ بمفتاح اختبار (sf_test_…): رسائله تذهب إلى الجهاز الافتراضي المدمج ولا تصل إلى أي هاتف حقيقي. ضعه في متغيرات البيئة:
export SMSFABRIC_API_KEY=sf_test_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxثم أرسل:
import { SMSFabric } from '@smsfabric/sdk';
const sms = new SMSFabric({ apiKey: process.env.SMSFABRIC_API_KEY });
const [message] = await sms.messages.send({ to: '+201001234567', body: 'Your order 1042 has shipped.',});
console.log(message?.id, message?.status); // msg_… queuedتعيد send كائن Message لكل مستلم بالحالة queued (أو blocked إذا كان الرقم في القائمة السوداء). يستمر التسليم في الخلفية: اقرأه عبر sms.messages.get(id) أو استقبله كخطاف ويب message.delivered.
ما تغطيه الحزمة
Section titled “ما تغطيه الحزمة”كل خاصية في العميل مورد مستقل. ولكل قائمة مقسمة إلى صفحات دالة listAll تعيد مكررًا غير متزامن يتتبع المؤشرات نيابة عنك.
| الخاصية | ما تغطيه | الصفحة |
|---|---|---|
messages |
الإرسال والعرض والقراءة والإحصاءات اليومية وتصدير CSV | الرسائل |
verifications |
رموز التحقق: إرسال وفحص وقراءة وعرض، وsettings للحماية من استنزاف الرسائل |
التحقق |
devices |
رموز الإقران وهواتف البوابة وشرائحها | الأجهزة |
pools |
مجموعات هواتف عالية التوافر | الأجهزة |
contacts |
جهات الاتصال وgroups واستيراد CSV عبر imports |
جهات الاتصال |
templates |
قوالب الرسائل مع {{variables}} والمعاينة |
جهات الاتصال |
campaigns |
الإرسال الجماعي: تقدير وبدء وإيقاف مؤقت واستئناف وإلغاء وتقرير | الحملات |
webhooks |
نقاط الاستقبال والتسليمات وإعادة الإرسال وأحداث الاختبار والتحقق من التوقيع | خطافات الويب |
apiKeys |
إنشاء مفاتيح API وتدويرها وإبطالها | مفاتيح API |
org |
ملف المؤسسة وmembers وinvitations |
الحساب |
preferences |
فترة التهدئة والتأخير العشوائي والشريحة الافتراضية ونافذة الإرسال والمنطقة الزمنية | الحساب |
audit |
سجل التدقيق الخاص بالمؤسسة | الحساب |
blacklist |
أرقام لا تصلها أي رسالة | الحساب |
http |
العميل منخفض المستوى، لنقطة نهاية لا دالة لها بعد | الإعداد |