برانڈ اور یوز کیس کو ایک ساتھ رکھیں
اپنے اکاؤنٹ پر موجود برانڈ ID اور اسی برانڈ کی اہلیت کی فہرست سے واپس کی گئی یوز کیس ویلیو استعمال کریں۔ کسٹمر ورک فلو فراہم کنندہ کی درخواست سے پہلے ملکیت کی جانچ کرتا ہے۔ تصدیق کریں کہ واپس کیے گئے آبجیکٹ کا usecase منتخب ویلیو سے مطابقت رکھتا ہے۔ ایک برانڈ یا یوز کیس کے لیے لُک اپ کسی دوسرے کے لیے ضروریات قائم نہیں کرتا۔
موجودہ ضروریات پڑھیں
| فیلڈ | پورٹل اسے کیسے استعمال کرتا ہے |
|---|---|
| minSubUsecases / maxSubUsecases | اس انتخاب کے لیے ذیلی یوز کیسز کی کم از کم اور زیادہ سے زیادہ تعداد۔ آزاد متن کے بجائے درست ذیلی یوز کیس کیٹلاگ سے ویلیوز منتخب کریں۔ |
| mnoMetadata | کیریئر ID کے لحاظ سے ترتیب دی گئی کیریئر مخصوص ضروریات۔ کیریئر کے انتخاب کے لیے موجودہ جواب میں موجود IDs استعمال کریں۔ |
| mnoSupport / qualify | کیریئر کی معاونت اور اہلیت۔ پورٹل ان کیریئرز کو خارج کر دیتا ہے جو کسی بھی فیلڈ کے لیے واضح طور پر false نشان زد ہوں اور کم از کم ایک اہل منتخب کیریئر کا تقاضا کرتا ہے۔ |
| minMsgSamples | کسی کیریئر کے لیے درکار نمونوں کی تعداد۔ پورٹل کم از کم ایک غیر خالی نمونے کا تقاضا کرتا ہے اور اہل منتخب کیریئرز میں سب سے زیادہ کم از کم حد کو پورا کرتا ہے۔ |
| reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp | درکار سبسکرائبر اعلانات۔ جہاں درکار ہو، متعلقہ اعلان true ہونا چاہیے۔ فعال اعلانات کو ان کے کلیدی لفظ اور جوابی پیغام کی فیلڈز بھی درکار ہوتی ہیں۔ |
| noEmbeddedLink / noEmbeddedPhone | شامل کردہ لنکس یا فون نمبرز پر پابندیاں۔ اگر کوئی اہل منتخب کیریئر کسی اعلان کردہ خصوصیت کی ممانعت کرے تو پورٹل اسے مسترد کر دیتا ہے۔ |
منتخب کیریئرز کی ضروریات کو ایک ساتھ لاگو کریں
کیریئر کی ضروریات مختلف ہو سکتی ہیں۔ جب کوئی واضح کیریئر فہرست فراہم نہ کی جائے تو پورٹل جواب میں موجود تمام کیریئر میٹا ڈیٹا پر غور کرتا ہے؛ ایک غیر خالی فہرست جانچوں کو انہی منتخب IDs تک محدود کر دیتی ہے۔ صرف پہلے کیریئر کے نمونوں کی تعداد یا اعلانات استعمال نہ کریں۔ جواب سے کیریئرز منتخب کریں، معاونت اور اہلیت کی جانچ کریں، سب سے زیادہ قابلِ اطلاق نمونوں کی کم از کم حد کو پورا کریں، اور اس پورے انتخاب میں درکار آپٹ اِن، آپٹ آؤٹ اور ہیلپ اعلانات کو پورا کریں۔ پورٹل ایسے منتخب کیریئر IDs کو مسترد کر دیتا ہے جو موجودہ جواب میں موجود نہ ہوں اور ایسے انتخاب کو بھی مسترد کرتا ہے جس میں کوئی اہل کیریئر نہ ہو۔
ضروریات یہ بیان کرتی ہیں کہ کیا فراہم کیا جانا چاہیے؛ یہ ثابت نہیں کرتیں کہ کسٹمر کا رضامندی کا عمل یا مہم کا مواد ان ضروریات کو پورا کرتا ہے۔ سچے اور نمائندہ نمونے اور اعلانات جمع کریں۔ فارم پاس کروانے کے لیے اعلانات کو خودکار طور پر فعال نہ کریں۔
نمونے اور سبسکرائبر جوابات تیار کریں
موجودہ مہم فارم پیغام کے نمونوں کے لیے sample1 سے sample5 تک استعمال کرتا ہے۔ اگر ضروریات دستیاب فارم کے اندر پوری نہ کی جا سکیں تو رک جائیں اور سپورٹ کے ساتھ انتخاب کو حل کریں۔ فعال سبسکرائبر اعلان کے لیے اس کے متعلقہ کلیدی الفاظ اور جوابی متن فراہم کریں: optinKeywords/optinMessage، optoutKeywords/optoutMessage، اور helpKeywords/helpMessage۔ نمونوں کو منتخب یوز کیس اور کسٹمر کی اصل پیغام رسانی کے مطابق رکھیں۔
کسی بھی رجسٹریشن درخواست سے پہلے جائزہ لیں
جب برانڈ، یوز کیس یا کیریئر کا انتخاب تبدیل ہو تو ضروریات کو تازہ کریں۔ پورٹل تخلیق سے پہلے منتخب یوز کیس، ذیلی یوز کیس کی تعداد، کیریئر کی اہلیت، نمونوں اور اعلانات کی دوبارہ توثیق کرتا ہے۔ اکاؤنٹ کی قیمتوں اور رجسٹریشن کی شرائط کا الگ سے جائزہ لیں۔ یہ GET کسی مہم کو رجسٹر یا منظور نہیں کرتا، اسے پیغام رسانی کیریئر کے ساتھ شیئر نہیں کرتا اور نہ ہی فون نمبر تفویض کرتا ہے۔ تخلیق اور پروویژننگ الگ الگ آپریشنز ہیں۔
ناکام ضروریات لُک اپ کو سنبھالیں
اگر درخواست ناکام ہو جائے، غیر متوقع JSON واپس کرے یا منتخب یوز کیس سے مطابقت نہ رکھے تو فارم کو نامکمل رکھیں اور خرابی حل ہونے کے بعد کسٹمر کو دوبارہ کوشش کرنے دیں۔ غیر دستیاب ضروریات کو خالی آبجیکٹ سے تبدیل نہ کریں اور نہ ہی یہ فرض کریں کہ غائب ڈیٹا کا مطلب کوئی ضروریات نہیں ہیں۔ Retry-After کا احترام کریں اور شرح کی حدود اور دستیابی کی ناکامیوں کے لیے بیک آف استعمال کریں۔
درخواست
اجازت یافتہ ماخذ IP ایڈریس سے HTTPS پر فعال API اکاؤنٹ استعمال کریں۔ موجودہ روٹ اکاؤنٹ کی تصدیقی پالیسی کی معاونت کرتا ہے، بشمول Basic تصدیق اور فعال بیئرر API اکاؤنٹس۔ فراہم کنندہ کی اسناد استعمال نہ کریں۔
URL راستے میں برانڈ ID اور منتخب یوز کیس ویلیو کے ساتھ GET کریں۔ کسی درخواستی باڈی کی ضرورت نہیں ہے۔
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"| نام | قسم | درکار | تفصیل |
|---|---|---|---|
brand_id | string | ہاں | آپ کے تصدیق شدہ MultiTEL اکاؤنٹ سے منسلک رجسٹری برانڈ ID۔ برانڈ ID استعمال کریں، مقامی ڈیٹا بیس رو ID، مہم ID یا کاروباری ٹیکس نمبر نہیں۔ اسے ایک URL راستے کے سیگمنٹ کے طور پر انکوڈ کریں۔ |
usecase | string | ہاں | اسی برانڈ کی اہلیت کی فہرست سے منتخب کردہ مشین کے پڑھنے کے قابل usecase ویلیو۔ اس کے حروف کی حالت (کیس) برقرار رکھیں؛ ترجمہ شدہ ڈسپلے لیبل نہ بھیجیں۔ اسے ایک URL راستے کے سیگمنٹ کے طور پر انکوڈ کریں۔ |
جواب
موجودہ TCR روٹ رجسٹری JSON باڈی کو براہِ راست واپس کرتا ہے اور اس کی HTTP اسٹیٹس برقرار رکھتا ہے۔ یہ پرانا v3 status/response لفافہ شامل نہیں کرتا۔ مختصر فرضی مثال کوئی لائیو اہلیت کا نتیجہ نہیں ہے۔ اسے استعمال کرنے سے پہلے HTTP اسٹیٹس اور متوقع JSON ساخت کی جانچ کریں۔ پورٹل ایسے آبجیکٹ کی توقع کرتا ہے جس کا usecase منتخب یوز کیس سے مطابقت رکھتا ہو۔ کیریئر کی ضروریات mnoMetadata کے تحت ہیں، جو کیریئر ID کے لحاظ سے ترتیب دی گئی ہیں۔ مثال میں دیا گیا کیریئر ID اور ضروریات فرضی ہیں۔ فراہم کنندہ کی دیگر فیلڈز بھی واپس کی جا سکتی ہیں۔
وضاحتی جواب کی ساخت؛ لائیو اکاؤنٹ ڈیٹا یا موجودہ قیمت کا تخمینہ نہیں۔
{
"usecase": "2FA",
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": {
"12345": {
"mnoSupport": true,
"qualify": true,
"minMsgSamples": 1,
"reqSubscriberOptin": true,
"reqSubscriberOptout": true,
"reqSubscriberHelp": true,
"noEmbeddedLink": false,
"noEmbeddedPhone": false
}
}
}خرابیاں
- 401: اکاؤنٹ کی تصدیق ناکام ہو گئی۔ API اسناد، فعال حالت اور قابلِ اطلاق ماخذ IP پابندیوں کی جانچ کریں۔
- 404: برانڈ تصدیق شدہ اکاؤنٹ سے منسلک نہیں ہے، یا فراہم کنندہ درخواست کردہ برانڈ یا انتخاب کو تلاش نہیں کر سکتا۔ فراہم کنندہ کی درخواست سے پہلے مقامی ملکیت سے انکار واپس کیا جاتا ہے۔
- رجسٹری کی دیگر خرابیاں: اپ اسٹریم HTTP اسٹیٹس اور باڈی برقرار رکھی جاتی ہیں۔ غلط یا غیر دستیاب یوز کیس کامیاب خالی ضروریات کا سیٹ نہیں ہے۔
- 429: اکاؤنٹ یا مشترکہ فراہم کنندہ کی درخواست کی حد تک پہنچ گئی۔ Retry-After کا احترام کریں۔
- 502/503: ٹرانسپورٹ، فراہم کنندہ یا ریٹ لمیٹر کی دستیابی کی ناکامی۔ فارم کو محفوظ رکھیں اور بیک آف کے ساتھ دوبارہ کوشش کریں۔
دستیابی اور ضمنی اثرات
- جائزہ شدہ GET موجودہ برانڈ کی ملکیت کی جانچ کرتا ہے، رجسٹری سے رابطہ کرتا ہے اور درخواست کے آڈٹ ریکارڈز لکھتا ہے۔ یہ کوئی برانڈ یا مہم تخلیق نہیں کرتا اور نہ ہی رجسٹریشن فیس وصول کرتا ہے۔
- فراہم کنندہ کی فیس کا میٹا ڈیٹا MultiTEL کسٹمر کا خوردہ قیمت کا تخمینہ نہیں ہے۔ پورٹل بعد کی رجسٹریشن درخواست سے پہلے اکاؤنٹ کی قیمتوں کا الگ سے جائزہ لیتا ہے۔
- اہلیت اور ضروریات تبدیل ہو سکتی ہیں۔ جمع کرانے سے پہلے منتخب برانڈ اور یوز کیس کے لیے انہیں تازہ کریں۔ کامیاب لُک اپ مہم کی منظوری، نمبر کی تفویض یا پیغام رسانی شروع کرنے کی اجازت نہیں ہے۔