ڈیولپرز

GET/tcr/v2/campaignBuilder/brand/{brand_id}

کسی برانڈ کے لیے دستیاب مہم کے استعمالات کی جانچ کریں

گاہک سے مہم ترتیب دینے کو کہنے سے پہلے معلوم کریں کہ رجسٹری آپ کے اکاؤنٹ میں موجود برانڈ کے لیے مہم کے کون سے استعمالات پیش کرتی ہے۔

اس صفحے پر
  1. اپنے اکاؤنٹ میں موجود برانڈ منتخب کریں
  2. اس نتیجے کی بنیاد پر استعمال کے اختیارات تیار کریں
  3. منتخب استعمال کی ضروریات لوڈ کریں
  4. اکاؤنٹ کی قیمتوں کا الگ سے جائزہ لیں
  5. برانڈ یا استعمال بدلنے پر معلومات تازہ کریں
  6. درخواست
  7. جواب
  8. خرابیاں
  9. دستیابی اور ضمنی اثرات

اپنے اکاؤنٹ میں موجود برانڈ منتخب کریں

رجسٹری میں برانڈ کے اس شناختی نمبر سے شروع کریں جو پہلے ہی آپ کے MultiTEL اکاؤنٹ سے منسلک ہے۔ یہ تلاش کوئی برانڈ نہیں بناتی اور نہ ہی کسی دوسرے شخص کا برانڈ آپ کے اکاؤنٹ سے منسلک کرتی ہے۔ گاہکوں کے لیے موجودہ طریقۂ کار اہلیت کی معلومات مانگنے سے پہلے ملکیت کی جانچ کرتا ہے۔ اگر تلاش کے جواب میں 404 آئے تو مقامی قطار کا شناختی نمبر استعمال کرنے کے بجائے منتخب اکاؤنٹ اور برانڈ کی تصدیق کریں۔

اس نتیجے کی بنیاد پر استعمال کے اختیارات تیار کریں

استعمالات کا عمومی کیٹلاگ رجسٹری کے اختیارات بیان کرتا ہے۔ کسی مخصوص برانڈ کی یہ تلاش منتخب برانڈ کے لیے اختیارات فراہم کرتی ہے۔ واپس ملنے والے ہر usecase کی قدر محفوظ رکھیں اور اسے کیٹلاگ کے نمائشی عنوان اور تفصیل کے ساتھ ملائیں۔ عمومی کیٹلاگ کی ہر مد کو اس طرح پیش نہ کریں جیسے برانڈ اس کے لیے اہل ہو۔

پورٹل کو توقع ہے کہ یہ جواب JSON کی فہرست ہوگا۔ اگر جواب موجود نہ ہو، اس کی ساخت غلط ہو یا اس میں خرابی ہو تو گاہک کا فارم محفوظ رکھیں اور دکھائیں کہ اہلیت کی معلومات لوڈ نہیں ہو سکیں۔ خاموشی سے اسے پہلے سے طے شدہ استعمال کی منظوری نہ سمجھیں۔ رجسٹری مختصر مثال میں دکھائے گئے خانوں کے علاوہ مزید خانے بھی واپس کر سکتی ہے۔

منتخب استعمال کی ضروریات لوڈ کریں

گاہک کے واپس ملنے والی استعمال کی قدر منتخب کرنے کے بعد، درخواست بھیجیں: /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase}، اور یہ درخواست اسی برانڈ کے لیے ہو۔ اس کا جواب ذیلی استعمالات کی حدیں اور ٹیلی کام آپریٹر کے لحاظ سے مخصوص ضروریات فراہم کرتا ہے۔ اسے پیغامات کے نمونے، رضامندی اور دیگر لازمی اقرارات جمع کرنے کے لیے استعمال کریں۔ صرف اہلیت کی فہرست مہم کے اندراج کی مکمل درخواست تیار کرنے کے لیے کافی نہیں ہے۔

اکاؤنٹ کی قیمتوں کا الگ سے جائزہ لیں

فراہم کنندہ کے خانے، مثلاً monthlyFee، quarterlyFee یا annualFee، جب جواب میں آئیں تو فراہم کنندہ کی فیسوں سے متعلق میٹا ڈیٹا بیان کرتے ہیں۔ یہ گاہک کے اکاؤنٹ کی قیمت یا اندراج کی شرائط کا متبادل نہیں ہیں۔ موجودہ پورٹل گاہک کے لیے مہم کی قیمتیں الگ سے پڑھتا ہے اور اپنے جائزے کے صفحے پر انہیں اہلیت کے ڈیٹا کے ساتھ ملاتا ہے۔ شمارشی اقدار کے پرانے معاون جزو میں کوڈ کے اندر مقرر کردہ قیمتوں سے گاہک پر عائد ہونے والی رقم اخذ نہ کریں۔

برانڈ یا استعمال بدلنے پر معلومات تازہ کریں

برانڈ بدلتے وقت پچھلے برانڈ کے اختیارات ہٹا دیں اور نئے انتخاب کے لیے اہلیت کی معلومات لوڈ کریں۔ جمع کرانے سے پہلے منتخب استعمال کی ضروریات تازہ کریں۔ یہ GET درخواستیں اندراج کی درخواست جمع نہیں کراتیں، مہم فعال نہیں کرتیں اور نمبر مختص نہیں کرتیں۔

درخواست

اجازت یافتہ ماخذ کے آئی پی پتے سے HTTPS کے ذریعے فعال API اکاؤنٹ استعمال کریں۔ موجودہ راستہ اکاؤنٹ کی توثیق کی پالیسی کی معاونت کرتا ہے، جس میں Basic توثیق اور حامل ٹوکن استعمال کرنے والے فعال API اکاؤنٹس شامل ہیں۔ فراہم کنندہ کی اسناد استعمال نہ کریں۔

ویب پتے کے راستے میں برانڈ کا شناختی نمبر رکھ کر GET درخواست بھیجیں۔ درخواست کے متن کی ضرورت نہیں ہے۔

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"
راستے کے پیرامیٹرز
نامقسملازمیتفصیل
brand_idمتنی سلسلہہاںرجسٹری میں برانڈ کا وہ شناختی نمبر جو آپ کے توثیق شدہ MultiTEL اکاؤنٹ سے منسلک ہے۔ برانڈ کا شناختی نمبر استعمال کریں، نہ کہ مقامی ڈیٹابیس کی قطار کا شناختی نمبر، مہم کا شناختی نمبر یا کاروبار کا ٹیکس نمبر۔ اسے ویب پتے کے راستے کے ایک ہی حصے کے طور پر انکوڈ کریں۔

جواب

موجودہ TCR راستہ رجسٹری کا JSON متن براہ راست واپس کرتا ہے اور اس کی HTTP حیثیت برقرار رکھتا ہے۔ یہ پرانے v3 کا status/response غلاف شامل نہیں کرتا۔ مختصر فرضی مثال اہلیت کا حقیقی وقت میں حاصل کردہ نتیجہ نہیں ہے۔ اسے استعمال کرنے سے پہلے HTTP حیثیت اور JSON کی متوقع ساخت جانچیں۔ موجودہ پورٹل کو اہلیت کے ریکارڈوں کی فہرست درکار ہے، جس کا ہر ریکارڈ ایک usecase کی نشاندہی کرے۔ یہ نمائشی عنوانات کے لیے ان ریکارڈوں کو usecase کیٹلاگ کے ساتھ ملاتا ہے اور گاہک کی قیمتیں الگ سے پڑھتا ہے۔ فراہم کنندہ کے اضافی خانے بھی موجود ہو سکتے ہیں۔

جواب کی ساخت کی وضاحتی مثال؛ یہ اکاؤنٹ کا حقیقی وقت کا ڈیٹا یا موجودہ قیمت کی پیشکش نہیں ہے۔

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

خرابیاں

  • 401: اکاؤنٹ کی توثیق ناکام ہو گئی۔ API کی اسناد، فعال ہونے کی حالت اور ماخذ کے آئی پی پتے پر لاگو پابندیاں جانچیں۔
  • 404: برانڈ توثیق شدہ اکاؤنٹ سے منسلک نہیں ہے، یا فراہم کنندہ مطلوبہ برانڈ یا انتخاب تلاش نہیں کر سکتا۔ مقامی ملکیت کی جانچ میں انکار ہونے پر فراہم کنندہ کو درخواست بھیجنے سے پہلے ہی انکار کا جواب واپس کیا جاتا ہے۔
  • رجسٹری کی دیگر خرابیاں: بالائی سروس سے موصول ہونے والی HTTP حیثیت اور جواب کا متن برقرار رکھے جاتے ہیں۔ غلط یا غیر دستیاب استعمال کو کامیاب جواب میں ضروریات کا خالی مجموعہ نہ سمجھیں۔
  • 429: اکاؤنٹ یا فراہم کنندہ کی مشترکہ درخواستوں کی حد پوری ہو گئی ہے۔ Retry-After کی ہدایت پر عمل کریں۔
  • 502/503: ترسیل، فراہم کنندہ یا درخواستوں کی شرح محدود کرنے والے جزو کی دستیابی میں خرابی ہے۔ فارم محفوظ رکھیں اور ہر اگلی کوشش سے پہلے وقفہ بڑھاتے ہوئے دوبارہ کوشش کریں۔

دستیابی اور ضمنی اثرات

  • جائزہ لی گئی GET درخواست موجودہ برانڈ کی ملکیت جانچتی ہے، رجسٹری سے رابطہ کرتی ہے اور درخواستوں کی آڈٹ کے ریکارڈ لکھتی ہے۔ یہ کوئی برانڈ یا مہم نہیں بناتی اور اندراج کی فیس وصول نہیں کرتی۔
  • فراہم کنندہ کی فیسوں کا میٹا ڈیٹا MultiTEL کے گاہک کے لیے قیمت کی پیشکش نہیں ہے۔ پورٹل بعد میں بھیجی جانے والی اندراج کی درخواست سے پہلے اکاؤنٹ کی قیمتوں کا الگ سے جائزہ لیتا ہے۔
  • اہلیت اور ضروریات بدل سکتی ہیں۔ جمع کرانے سے پہلے منتخب برانڈ اور استعمال کے لیے انہیں تازہ کریں۔ کامیاب تلاش مہم کی منظوری، نمبر کی تخصیص یا پیغامات بھیجنا شروع کرنے کی اجازت نہیں ہے۔