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

منع التكرار

قد تنقطع الشبكة بعد أن تقبل الواجهة طلبك وقبل أن تصلك الاستجابة. إذا أعدت المحاولة دون احتياط، يصل العميل الرسالة مرتين. أرسل الترويسة Idempotency-Key لتنفذ SMSFabric الطلب مرة واحدة، ثم تعيد الاستجابة المحفوظة لكل محاولة تحمل المفتاح نفسه.

  1. ترسل طلب إنشاء مع Idempotency-Key: <your key>.
  2. تحجز SMSFabric المفتاح لمؤسستك وتنفذ الطلب.
  3. عند النجاح تُحفظ الاستجابة (الحالة والمحتوى) مشفرة لمدة 24 ساعة.
  4. أي إعادة بالمفتاح نفسه والطلب نفسه تعيد تلك الاستجابة مع الترويسة Idempotent-Replayed: true، ولا يُنفذ شيء من جديد.

الطلب الفاشل (أي 4xx أو 5xx) لا يستهلك المفتاح، فيمكنك تصحيح الطلب وإرساله بالمفتاح نفسه.

المفاتيح خاصة بمؤسستك: يمكن لمؤسستين استخدام المفتاح نفسه دون تعارض.

نقاط النهاية التي تقبله

Section titled “نقاط النهاية التي تقبله”

كل طلب POST ينشئ شيئا:

نقطة النهاية تنشئ
POST /v1/messages رسائل
POST /v1/verifications عملية تحقق (رمز لمرة واحدة)
POST /v1/contacts جهة اتصال
POST /v1/contact-groups مجموعة جهات اتصال
POST /v1/templates قالبا
POST /v1/campaigns مسودة حملة
POST /v1/blacklist مدخلا في القائمة السوداء
POST /v1/webhooks نقطة نهاية webhook
POST /v1/devices/pairing-tokens رمز إقران
POST /v1/pools مجموعة أجهزة
POST /v1/api-keys مفتاح API (للمستخدمين المسجلين فقط)
POST /v1/org/invitations دعوة إلى الفريق (للمستخدمين المسجلين فقط)

تتجاهل باقي نقاط النهاية الترويسة. أما طلبات PATCH وPUT وDELETE فتكرارها آمن بطبيعتها.

  • من 1 إلى 255 حرفا من A–Z a–z 0–9 _ - : .. أي شيء آخر يعيد 400 invalid_idempotency_key.
  • اشتقه من بياناتك متى أمكن: order-1042-shipped أو signup:usr_8812:otp. هكذا تستخدم أي إعادة من عامل آخر أو بعد إعادة التشغيل المفتاح نفسه.
  • وإلا فولّد UUID مرة واحدة لكل عملية منطقية واحفظه مع المهمة، لا مع كل محاولة HTTP.
نافذة طرفيّة
# Run this twice: the second call returns the same message ids
# and the header "Idempotent-Replayed: true".
curl -i https://api.smsfabric.com/v1/messages \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: invoice-7781-reminder" \
-d '{"to": "+201001234567", "body": "Invoice 7781 is due on 1 December."}'
الحالة code المعنى ما العمل
400 invalid_idempotency_key المفتاح فارغ أو طويل جدا أو فيه أحرف غير مسموحة. استخدم من 1 إلى 255 حرفا من A–Z a–z 0–9 _ - : ..
409 idempotency_in_progress الطلب الأول بهذا المفتاح ما زال قيد التنفيذ. انتظر ثانية وأعد المحاولة بالمفتاح نفسه.
422 idempotency_key_reused استُخدم المفتاح خلال آخر 24 ساعة مع طريقة أو مسار أو محتوى مختلف. استخدم مفتاحا جديدا لكل عملية جديدة، ولا تكرر مفتاحا لمحتوى مختلف.