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

التفضيلات

تنطبق التفضيلات على كل رسالة ترسلها مؤسستك. تجدها في البوابة تحت الإعدادات ← الإرسال.

الحقل النوع الافتراضي الوصف
cooldownMs integer 3000 فترة انتظار بين رسالتين على الهاتف نفسه، تحمي شرائحك من مرشحات الرسائل المزعجة لدى شركات الاتصالات.
jitterMs integer 2000 انتظار إضافي عشوائي من 0 حتى هذه القيمة يُضاف إلى فترة الانتظار.
maxRetries integer 2 عدد مرات إعادة المحاولة بعد أن يبلّغ الهاتف عن فشل الإرسال.
defaultDeviceId string أو null الهاتف الافتراضي.
defaultSimId string أو null الشريحة الافتراضية، وتُضبط تلقائيا على أول شريحة في أول هاتف تقرنه.
sendWindow object أو null null { start, end, tz }: الرسائل الحقيقية خارج هذه النافذة اليومية تنتظر حتى تُفتح.
forwardInbound object أو null null { email?, phone?, webhook? }: إلى أين تُنسخ الرسائل الواردة. انظر استقبال الرسائل.
timeZone string UTC منطقة IANA للمؤسسة، وتستخدمها الحملات للأرقام مجهولة الدولة.
GET/v1/preferences

يستطيع أي مفتاح API أو مستخدم في المؤسسة قراءتها دون صلاحية محددة.

نافذة طرفيّة
curl https://api.smsfabric.com/v1/preferences \
-H "X-Api-Key: $SMSFABRIC_API_KEY"
{
"cooldownMs": 3000,
"jitterMs": 2000,
"maxRetries": 2,
"defaultDeviceId": "dev_m4p7s2v5y8b1e4h7k0n3q6t9",
"defaultSimId": "sim_r2t4v6x8z1b3d5f7h9j2l4n6",
"sendWindow": { "start": "08:00", "end": "22:00", "tz": "Africa/Cairo" },
"forwardInbound": { "email": "support@acme.example" },
"timeZone": "Africa/Cairo"
}
PATCH/v1/preferencessettings:manage

أرسل الحقول التي تريد تغييرها فقط. القيمة null تمسح sendWindow أو forwardInbound أو defaultDeviceId أو defaultSimId. يعيد التفضيلات. يُسجل في التدقيق باسم preferences.updated.

حقل المحتوى النوع القيود
cooldownMs integer من 0 إلى 600000.
jitterMs integer من 0 إلى 600000.
maxRetries integer من 0 إلى 10.
defaultDeviceId string أو null هاتف في مؤسستك.
defaultSimId string أو null شريحة في مؤسستك.
sendWindow object أو null start وend بصيغة HH:mm (نظام 24 ساعة)، وtz منطقة IANA.
forwardInbound object أو null email (بريد صالح)، وphone (E.164)، وwebhook (رابط https عام، يُفحص مثل نقاط نهاية webhook).
timeZone string منطقة IANA.
نافذة طرفيّة
curl -X PATCH https://api.smsfabric.com/v1/preferences \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sendWindow": {"start": "08:00", "end": "22:00", "tz": "Africa/Cairo"}, "cooldownMs": 5000}'
الخطأ متى
400 validation_failed هاتف أو شريحة غير معروفة، أو منطقة زمنية غير معروفة، أو HH:mm غير صالحة.
400 ssrf_blocked forwardInbound.webhook ليس رابط https عاما.