ডেভেলপার

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

একটি ব্র্যান্ডের ক্যাম্পেইন প্রয়োজনীয়তা পড়ুন

ক্যাম্পেইন নিবন্ধন প্রস্তুত করার আগে নির্বাচিত ইউজ কেসের সাব-ইউজ-কেস সীমা, ক্যারিয়ার যোগ্যতা এবং বার্তার প্রয়োজনীয়তা পড়ুন।

এই পৃষ্ঠায়
  1. ব্র্যান্ড এবং ইউজ কেস একসাথে রাখুন
  2. বর্তমান প্রয়োজনীয়তা পড়ুন
  3. নির্বাচিত ক্যারিয়ারগুলোর প্রয়োজনীয়তা একসাথে প্রয়োগ করুন
  4. নমুনা এবং সাবস্ক্রাইবার রেসপন্স প্রস্তুত করুন
  5. যেকোনো নিবন্ধন অনুরোধের আগে পর্যালোচনা করুন
  6. ব্যর্থ প্রয়োজনীয়তা লুকআপ পরিচালনা করুন
  7. অনুরোধ
  8. রেসপন্স
  9. ত্রুটি
  10. উপলব্ধতা এবং পার্শ্বপ্রতিক্রিয়া

ব্র্যান্ড এবং ইউজ কেস একসাথে রাখুন

আপনার অ্যাকাউন্টের ব্র্যান্ড আইডি এবং সেই একই ব্র্যান্ডের যোগ্যতা তালিকা থেকে ফেরত আসা একটি ইউজ-কেস মান ব্যবহার করুন। গ্রাহক ওয়ার্কফ্লো প্রোভাইডার অনুরোধের আগে মালিকানা পরীক্ষা করে। নিশ্চিত করুন যে ফেরত আসা অবজেক্টের usecase নির্বাচিত মানের সাথে মেলে। একটি ব্র্যান্ড বা ইউজ কেসের জন্য লুকআপ অন্য কোনোটির জন্য প্রয়োজনীয়তা প্রতিষ্ঠা করে না।

বর্তমান প্রয়োজনীয়তা পড়ুন

বর্তমান ক্যাম্পেইন ফর্ম দ্বারা ব্যবহৃত প্রয়োজনীয়তা
ফিল্ডপোর্টাল এটি কীভাবে ব্যবহার করে
minSubUsecases / maxSubUsecasesএই নির্বাচনের জন্য সাব-ইউজ কেসের সর্বনিম্ন ও সর্বোচ্চ সংখ্যা। মুক্ত টেক্সটের পরিবর্তে বৈধ সাব-ইউজ-কেস ক্যাটালগ থেকে মান বেছে নিন।
mnoMetadataক্যারিয়ার আইডিকে কী হিসেবে ব্যবহার করে বিন্যস্ত ক্যারিয়ার-নির্দিষ্ট প্রয়োজনীয়তা। ক্যারিয়ার নির্বাচনের জন্য বর্তমান রেসপন্সে উপস্থিত আইডিগুলো ব্যবহার করুন।
mnoSupport / qualifyক্যারিয়ার সমর্থন এবং যোগ্যতা। পোর্টাল যেকোনো একটি ফিল্ডের জন্য স্পষ্টভাবে false চিহ্নিত ক্যারিয়ারগুলোকে বাদ দেয় এবং অন্তত একটি যোগ্য নির্বাচিত ক্যারিয়ার আবশ্যক করে।
minMsgSamplesএকটি ক্যারিয়ারের জন্য প্রয়োজনীয় নমুনার সংখ্যা। পোর্টাল অন্তত একটি অশূন্য নমুনা আবশ্যক করে এবং যোগ্য নির্বাচিত ক্যারিয়ারগুলোর মধ্যে সর্বোচ্চ ন্যূনতম মান পূরণ করে।
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelpপ্রয়োজনীয় সাবস্ক্রাইবার ঘোষণা। যেখানে আবশ্যক, সংশ্লিষ্ট ঘোষণাটি অবশ্যই true হতে হবে। সক্রিয় ঘোষণাগুলোর জন্য তাদের কীওয়ার্ড এবং রেসপন্স-বার্তা ফিল্ডও প্রয়োজন।
noEmbeddedLink / noEmbeddedPhoneএমবেডেড লিঙ্ক বা ফোন নম্বরের উপর বিধিনিষেধ। কোনো যোগ্য নির্বাচিত ক্যারিয়ার নিষিদ্ধ করলে পোর্টাল ঘোষিত বৈশিষ্ট্যটি প্রত্যাখ্যান করে।

নির্বাচিত ক্যারিয়ারগুলোর প্রয়োজনীয়তা একসাথে প্রয়োগ করুন

ক্যারিয়ারের প্রয়োজনীয়তা ভিন্ন হতে পারে। যখন কোনো স্পষ্ট ক্যারিয়ার তালিকা সরবরাহ করা হয় না, তখন পোর্টাল রেসপন্সের সমস্ত ক্যারিয়ার মেটাডেটা বিবেচনা করে; একটি অশূন্য তালিকা পরীক্ষাগুলোকে সেই নির্বাচিত আইডিগুলোতে সীমাবদ্ধ করে। শুধুমাত্র প্রথম ক্যারিয়ারের নমুনার সংখ্যা বা ঘোষণা ব্যবহার করবেন না। রেসপন্স থেকে ক্যারিয়ার নির্বাচন করুন, সমর্থন ও যোগ্যতা পরীক্ষা করুন, প্রযোজ্য সর্বোচ্চ ন্যূনতম নমুনা সংখ্যা পূরণ করুন এবং সেই নির্বাচন জুড়ে প্রয়োজনীয় অপ্ট-ইন, অপ্ট-আউট ও হেল্প ঘোষণাগুলো পূরণ করুন। পোর্টাল বর্তমান রেসপন্সে অনুপস্থিত নির্বাচিত ক্যারিয়ার আইডি প্রত্যাখ্যান করে এবং কোনো যোগ্য ক্যারিয়ার না থাকা নির্বাচনও প্রত্যাখ্যান করে।

প্রয়োজনীয়তা বর্ণনা করে কী সরবরাহ করতে হবে; এগুলো প্রমাণ করে না যে গ্রাহকের সম্মতি প্রক্রিয়া বা ক্যাম্পেইনের বিষয়বস্তু সেই প্রয়োজনীয়তা পূরণ করে। সত্যনিষ্ঠ, প্রতিনিধিত্বমূলক নমুনা ও ঘোষণা সংগ্রহ করুন। একটি ফর্ম পাস করানোর জন্য স্বয়ংক্রিয়ভাবে ঘোষণা চালু করবেন না।

নমুনা এবং সাবস্ক্রাইবার রেসপন্স প্রস্তুত করুন

বর্তমান ক্যাম্পেইন ফর্ম sample1 থেকে sample5 বার্তার নমুনার জন্য ব্যবহার করে। যদি উপলব্ধ ফর্মের মধ্যে প্রয়োজনীয়তা পূরণ করা না যায়, থামুন এবং সাপোর্টের সাথে নির্বাচনটি সমাধান করুন। একটি সক্রিয় সাবস্ক্রাইবার ঘোষণার জন্য, এর সংশ্লিষ্ট কীওয়ার্ড ও রেসপন্স টেক্সট দিন: optinKeywords/optinMessage, optoutKeywords/optoutMessage এবং helpKeywords/helpMessage। নমুনাগুলো নির্বাচিত ইউজ কেস এবং প্রকৃত গ্রাহক বার্তার সাথে সামঞ্জস্যপূর্ণ রাখুন।

যেকোনো নিবন্ধন অনুরোধের আগে পর্যালোচনা করুন

ব্র্যান্ড, ইউজ কেস বা ক্যারিয়ার নির্বাচন পরিবর্তিত হলে প্রয়োজনীয়তা রিফ্রেশ করুন। পোর্টাল তৈরির আগে নির্বাচিত ইউজ কেস, সাব-ইউজ-কেসের সংখ্যা, ক্যারিয়ার যোগ্যতা, নমুনা ও ঘোষণা পুনরায় যাচাই করে। অ্যাকাউন্টের মূল্য নির্ধারণ এবং নিবন্ধনের শর্তাবলি আলাদাভাবে পর্যালোচনা করুন। এই GET কোনো ক্যাম্পেইন নিবন্ধন বা অনুমোদন করে না, মেসেজিং ক্যারিয়ারের সাথে এটি শেয়ার করে না বা কোনো ফোন নম্বর বরাদ্দ করে না। তৈরি এবং প্রভিশনিং আলাদা অপারেশন।

ব্যর্থ প্রয়োজনীয়তা লুকআপ পরিচালনা করুন

যদি অনুরোধ ব্যর্থ হয়, অপ্রত্যাশিত JSON ফেরত দেয় বা নির্বাচিত ইউজ কেসের সাথে না মেলে, ফর্মটি অসম্পূর্ণ রাখুন এবং ত্রুটি সমাধানের পরে গ্রাহককে পুনরায় চেষ্টা করতে দিন। অনুপলব্ধ প্রয়োজনীয়তাকে একটি খালি অবজেক্ট দিয়ে প্রতিস্থাপন করবেন না বা ধরে নেবেন না যে অনুপস্থিত ডেটার অর্থ কোনো প্রয়োজনীয়তা নেই। Retry-After মেনে চলুন এবং রেট লিমিট ও উপলব্ধতা ব্যর্থতার জন্য ব্যাকঅফ ব্যবহার করুন।

অনুরোধ

একটি অনুমোদিত সোর্স IP ঠিকানা থেকে HTTPS-এর মাধ্যমে একটি সক্রিয় API অ্যাকাউন্ট ব্যবহার করুন। বর্তমান রুট অ্যাকাউন্ট প্রমাণীকরণ নীতি সমর্থন করে, যার মধ্যে Basic প্রমাণীকরণ এবং সক্রিয় বেয়ারার API অ্যাকাউন্ট অন্তর্ভুক্ত। প্রোভাইডার ক্রেডেনশিয়াল ব্যবহার করবেন না।

URL পাথে ব্র্যান্ড আইডি এবং নির্বাচিত ইউজ-কেস মান সহ 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_idstringহ্যাঁআপনার প্রমাণীকৃত MultiTEL অ্যাকাউন্টের সাথে যুক্ত রেজিস্ট্রি ব্র্যান্ড আইডি। ব্র্যান্ড আইডি ব্যবহার করুন, স্থানীয় ডেটাবেস রো আইডি, ক্যাম্পেইন আইডি বা ব্যবসায়িক কর নম্বর নয়। এটিকে একটি URL পাথ সেগমেন্ট হিসেবে এনকোড করুন।
usecasestringহ্যাঁএই একই ব্র্যান্ডের যোগ্যতা তালিকা থেকে নির্বাচিত মেশিন-পাঠযোগ্য usecase মান। এর কেস (বড়/ছোট হাতের অক্ষর) সংরক্ষণ করুন; অনূদিত ডিসপ্লে লেবেল পাঠাবেন না। এটিকে একটি URL পাথ সেগমেন্ট হিসেবে এনকোড করুন।

রেসপন্স

বর্তমান TCR রুট রেজিস্ট্রির JSON বডি সরাসরি ফেরত দেয় এবং এর HTTP স্ট্যাটাস সংরক্ষণ করে। এটি লিগ্যাসি v3 status/response এনভেলপ যোগ করে না। সংক্ষিপ্ত কাল্পনিক উদাহরণটি কোনো লাইভ যোগ্যতা ফলাফল নয়। ব্যবহারের আগে HTTP স্ট্যাটাস এবং প্রত্যাশিত JSON আকৃতি পরীক্ষা করুন। পোর্টাল এমন একটি অবজেক্ট প্রত্যাশা করে যার usecase নির্বাচিত ইউজ কেসের সাথে মেলে। ক্যারিয়ারের প্রয়োজনীয়তা mnoMetadata-এর অধীনে, ক্যারিয়ার আইডিকে কী হিসেবে ব্যবহার করে বিন্যস্ত থাকে। উদাহরণের ক্যারিয়ার আইডি এবং প্রয়োজনীয়তা কাল্পনিক। অন্যান্য প্রোভাইডার ফিল্ডও ফেরত আসতে পারে।

দৃষ্টান্তমূলক রেসপন্স আকৃতি; লাইভ অ্যাকাউন্ট ডেটা বা বর্তমান কোটেশন নয়।

{
  "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 গ্রাহক খুচরা কোটেশন নয়। পোর্টাল পরবর্তী নিবন্ধন অনুরোধের আগে অ্যাকাউন্টের মূল্য নির্ধারণ আলাদাভাবে পর্যালোচনা করে।
  • যোগ্যতা এবং প্রয়োজনীয়তা পরিবর্তিত হতে পারে। জমা দেওয়ার আগে নির্বাচিত ব্র্যান্ড ও ইউজ কেসের জন্য সেগুলো রিফ্রেশ করুন। একটি সফল লুকআপ কোনো ক্যাম্পেইন অনুমোদন, নম্বর বরাদ্দ বা মেসেজিং শুরু করার অনুমতি নয়।