المطوّرون

DELETE/tcr/v2/campaign/{campaignId}

إلغاء تفعيل حملة مراسلة

إخراج حملة من الخدمة، ومطابقة تخصيصات أرقامها، وفهم استجابة النجاح ذات المحتوى الفارغ.

في هذه الصفحة
  1. إلغاء تفعيل حملة مراسلة موجودة
  2. أزل تخصيصات الأرقام المعنية أولا
  3. أرسل طلب إلغاء التفعيل المقصود
  4. تحقق من التسجيل والتخصيصات معا
  5. الإخراج من الخدمة منفصل عن تسوية الحساب

إلغاء تفعيل حملة مراسلة موجودة

استخدم هذا المسار عند إخراج حملة مملوكة للحساب من الخدمة. احتفظ بمعرف الحملة لأغراض مطابقة البيانات والسجل التاريخي. لتصحيح المحتوى أو تحديث نص الموافقة، استخدم تحديث حملة مراسلة بدلا من ذلك.

أجر المصادقة باستخدام حساب API مفعل عبر HTTPS من عنوان IP مصدر مسموح به. استعلم عن الحملة أولا وتحقق من العلامة التجارية وأرقام الإرسال المرتبطة بها. يؤدي إلغاء التفعيل إلى تغيير التسجيل؛ ولا ينشئ حملة بديلة ولا ينقل الأرقام إلى حملة أخرى.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

أزل تخصيصات الأرقام المعنية أولا

لا تفصل عملية DELETE العامة للحملة أرقام الهاتف لدى مشغل خدمة المراسلة، ولا تزيل تخصيصها المحلي. استخدم سير عمل إزالة ربط الرقم بالحملة لكل رقم معني مملوك للحساب، ثم تحقق من تخصيصه. لا تؤدي إزالة التخصيص إلى التخلي عن رقم الهاتف.

ينفذ سير عمل «حذف العلامة التجارية» الأشمل في البوابة عمليات تنظيف الحملات والأرقام التابعة للعلامة قبل حذفها. لا تستخدم هذا الإجراء إذا كنت تنوي الاحتفاظ بالعلامة التجارية وحملاتها الأخرى. لا يوفر محرر الحملات العادي حاليا زرا مستقلا لحذف الحملة يعادل هذا المسار المباشر في API.

أرسل طلب إلغاء التفعيل المقصود

بعد مراجعة معرف الحملة وإعدادات الإرسال المعنية، أرسل DELETE دون جسم طلب بصيغة JSON:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

استجابة النجاح الموثقة هي HTTP 204 مع جسم استجابة فارغ. افحص حالة HTTP بدلا من توقع غلاف status/response بصيغة JSON. عند قبول الحذف، تضع الخدمة الحالية محليا علامة على مورد الحملة بأنه محذوف ومنتهي الصلاحية، وتضع علامة على سجل الحملة القديم بأنه منتهي الصلاحية. ولا يمتد الحذف إلى العلامة التجارية.

استخدم مفتاحا واحدا لعدم تكرار الأثر لهذا الطلب المقصود، واحتفظ بطريقة الطلب ومساره وسلسلة الاستعلام وبايتات جسمه كما هي تماما لإعادة إرساله. قد يعيد طلب مكرر لا يزال قيد المعالجة الحالة 409 مع Retry-After؛ أما الطلبات المكتملة فيمكن أن تعيد النتيجة المخزنة. لا يثبت خطأ مخزن مؤقتا أو انقطاع الاتصال ما إذا كان السجل قد نفذ الإجراء بالفعل. احتفظ بمعرف الحملة وبـ requestId عند توفره.

تحقق من التسجيل والتخصيصات معا

تحقق من الحالة الحالية للحملة والأرقام المعنية في البوابة بعد الطلب. قد تحتفظ API ببيانات الملكية الوصفية محليا بعد الإخراج من الخدمة، مما يتيح مواصلة التحقق من معرف مملوك للحساب؛ فلا تستنتج أن المعرف نفسه يجب أن يعيد دائما الحالة 404 محليا. يحدد السجل الحالة المعادة أو مدى توفر السجل الذي أخرج من الخدمة.

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

نتائج إلغاء التفعيل
النتيجةالخطوة التالية
204لا يتوقع وجود جسم للاستجابة. تحقق من حالة الحملة وتخصيصات الأرقام التي تدار بشكل مستقل.
400اقرأ رسالة الخطأ المقدمة بشأن التحقق من صحة البيانات أو حالة السجل. تحقق من معرف الحملة الدقيق وحالتها القائمة.
401, 403, 404تحقق من بيانات اعتماد API، وعنوان IP المصدر المسموح به، وملكية الحساب للحملة. لا تستخدم معرف عميل آخر بدلا منه.
409, 429ميز بين طلب لا يكرر الأثر لا يزال قيد التنفيذ أو يتعارض مع طلب آخر، وبين تقييد معدل الطلبات؛ والتزم بـ Retry-After عند توفره.
500, 502 أو انتهاء مهلة الانتظاراحتفظ بتفاصيل الطلب، واستعلم عن الحملة الموجودة، وطابق البيانات قبل إرسال طلب آخر.

الإخراج من الخدمة منفصل عن تسوية الحساب

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

إذا كان تسجيل المنشأة بأكمله سيخرج من الخدمة بعد مطابقة بيانات حملاته وتخصيصاته، فتابع إلى إخراج العلامة التجارية من الخدمة.