التحقق من حالات استخدام الحملات المتاحة لعلامة تجارية

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

ابدأ بمعرّف العلامة التجارية في السجل المرتبط بالفعل بحسابك لدى MultiTEL. لا تُنشئ عملية البحث هذه علامة تجارية ولا تربط علامة تجارية تخص شخصًا آخر بحسابك. يتحقق مسار عمل العميل الحالي من الملكية قبل طلب بيانات الأهلية. إذا أعادت عملية البحث 404، فتحقق من الحساب والعلامة التجارية المحددين بدلًا من استخدام معرّف صف محلي.

كوّن خيارات حالات الاستخدام من هذه النتيجة

يصف الدليل العام لحالات الاستخدام خيارات السجل. وتوفر عملية البحث الخاصة بالعلامة التجارية الخيارات المتاحة للعلامة المحددة. احتفظ بكل قيمة للحقل usecase تُعاد في الاستجابة، واربطها بتسمية العرض والوصف الواردين في الدليل. لا تعرض كل عناصر الدليل العام كما لو كانت العلامة التجارية مؤهلة لها.

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

حمّل متطلبات حالة الاستخدام المحددة

بعد أن يختار العميل إحدى قيم حالات الاستخدام المعادة، أرسل طلبًا إلى /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} للعلامة التجارية نفسها. توفر تلك الاستجابة الحدود الخاصة بحالات الاستخدام الفرعية والمتطلبات الخاصة بكل شركة اتصالات. استخدمها لجمع نماذج الرسائل والموافقة والإقرارات الأخرى المطلوبة. لا تكفي قائمة الأهلية وحدها لإعداد طلب مكتمل لتسجيل حملة.

راجع أسعار الحساب على نحو منفصل

حقول المزوّد مثل monthlyFee، quarterlyFee أو annualFee، عند إعادتها، تصف البيانات الوصفية لرسوم المزوّد. وهي لا تحل محل السعر المطبق على حساب العميل أو شروط التسجيل. تقرأ البوابة الحالية أسعار بيع الحملات للعملاء على نحو منفصل وتجمعها مع بيانات الأهلية في شاشة المراجعة. لا تستنتج الرسوم المفروضة على العميل من الأسعار المثبتة في الشفرة ضمن الدالة المساعدة القديمة للتعدادات.

حدّث البيانات عند تغيير العلامة التجارية أو حالة الاستخدام

عند التبديل بين العلامات التجارية، تجاهل خيارات العلامة السابقة وحمّل بيانات الأهلية للاختيار الجديد. حدّث متطلبات حالة الاستخدام المحددة قبل الإرسال. لا تُرسل طلبات GET هذه طلب تسجيل، ولا تُفعّل حملة، ولا تُخصّص أرقامًا.

الطلب

استخدم حساب API مفعّلًا عبر HTTPS من عنوان IP مصدر مسموح به. يدعم المسار الحالي سياسة مصادقة الحساب، بما فيها مصادقة Basic وحسابات API المفعّلة التي تستخدم رمز حامل. لا تستخدم بيانات اعتماد المزوّد.

طلب GET مع معرّف العلامة التجارية في مسار عنوان URL. لا يلزم تضمين جسم للطلب.

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

الاستجابة

يعيد مسار TCR الحالي جسم استجابة السجل بتنسيق JSON مباشرةً ويحافظ على حالة HTTP الخاصة بها. ولا يضيف غلاف status/response القديم الخاص بالإصدار v3. المثال الافتراضي المختصر ليس نتيجة أهلية فعلية جرى جلبها مباشرةً. تحقق من حالة HTTP ومن البنية المتوقعة لتنسيق JSON قبل استخدام الاستجابة. تتوقع البوابة الحالية قائمة بسجلات الأهلية، يحدد كل منها usecase. وتجمع هذه السجلات مع دليل usecase للحصول على تسميات العرض، وتقرأ أسعار البيع للعملاء على نحو منفصل. قد توجد حقول إضافية خاصة بالمزوّد.

بنية استجابة توضيحية؛ ليست بيانات حساب فعلية جرى جلبها مباشرةً ولا عرض أسعار حاليًا.

[
  {
    "usecase": "2FA"
  }
]

الأخطاء

• 401: فشلت مصادقة الحساب. تحقق من بيانات اعتماد API وحالة تفعيل الحساب والقيود المطبقة على عنوان IP المصدر.
• 404: العلامة التجارية غير مرتبطة بالحساب الذي تمت مصادقته، أو تعذر على المزوّد العثور على العلامة التجارية أو الاختيار المطلوب. يُعاد رفض محلي بسبب عدم الملكية قبل إرسال طلب إلى المزوّد.
• أخطاء السجل الأخرى: يتم الاحتفاظ بحالة HTTP وجسم الاستجابة الواردين من الخدمة الخارجية. حالة الاستخدام غير الصالحة أو غير المتاحة لا تعني نجاح الطلب مع مجموعة متطلبات فارغة.
• 429: تم بلوغ حد طلبات الحساب أو الحد المشترك لطلبات المزوّد. التزم بما تحدده Retry-After.
• 502/503: فشل في النقل أو تعذر توفر المزوّد أو محدد معدل الطلبات. احتفظ بالنموذج وأعد المحاولة مع زيادة الفاصل الزمني بين المحاولات تدريجيًا.

التوفر والآثار الجانبية

• يتحقق طلب GET الذي تمت مراجعته من ملكية العلامة التجارية الموجودة، ويتصل بالسجل، ويكتب سجلات تدقيق الطلبات. ولا يُنشئ علامة تجارية أو حملة ولا يفرض رسوم تسجيل.
• البيانات الوصفية لرسوم المزوّد ليست عرض أسعار بيع لعميل MultiTEL. تراجع البوابة أسعار الحساب على نحو منفصل قبل تقديم طلب تسجيل لاحق.
• قد تتغير الأهلية والمتطلبات. حدّثها للعلامة التجارية وحالة الاستخدام المحددتين قبل الإرسال. نجاح عملية البحث لا يُعد موافقة على حملة أو تخصيصًا لأرقام أو إذنًا ببدء إرسال الرسائل.