মজুতে নম্বর আছে এমন মার্কিন অঙ্গরাজ্য বা কানাডীয় প্রদেশের তালিকা পান

যুক্তরাষ্ট্র বা কানাডার ক্ষেত্রে অঙ্গরাজ্য বা প্রদেশ অনুযায়ী অনুসন্ধান সীমিত করতে এই ঐচ্ছিক ধাপটি ব্যবহার করুন। শুধু US ও CA গ্রহণ করা হয়।

• প্রতিটি এন্ট্রি অনুরোধ করার সময় সংশ্লিষ্ট অঙ্গরাজ্যের মজুতে থাকা প্রিফিক্সগুলোর তথ্য দেয়।
• অঙ্গরাজ্যের এলাকাগুলোর তালিকা পেতে next_function অনুসরণ করুন। এতে ইতিমধ্যেই state ফিল্টারটি রয়েছে, তবে নেই pid।
• এলাকা অনুসন্ধানে অঙ্গরাজ্যের তথ্য কিছুটা ভিন্নভাবে মেলানো হয়। কোনো অঙ্গরাজ্যের next_function যদি No areas found ফেরত দেয়, তাহলে getareas অঙ্গরাজ্য উল্লেখ না করে কল করুন।
• প্রথমে যাচাই করুন status.code এবং তারপর পড়ুন response। অসমর্থিত দেশ বা যে দেশে শর্তের সঙ্গে মেলে এমন মজুত নেই, তার জন্য ফেরত আসা কোড হলো 404; এর সঙ্গে মিলে যাওয়া HTTP স্ট্যাটাস থাকে না।
• একটি খালি তালিকার সঙ্গে কোড 200 থাকলে বোঝায় যে মজুত আছে, কিন্তু তাতে অঙ্গরাজ্যের তথ্য নেই। getareas অঙ্গরাজ্য উল্লেখ না করে কল করুন।

অনুরোধ

আবশ্যক: HTTP Basic অথবা Bearer টোকেন (পরিচয় যাচাই ও API-এর প্রতিক্রিয়া দেখুন)। পরিচয় যাচাই ব্যর্থ হলে অনুসন্ধান চালানোর আগেই HTTP 401 দিয়ে উত্তর দেওয়া হয়।

GET অনুরোধে পাথের মধ্যে isocode থাকে। পাথের ওই অংশটি বাদ দিলে তার পরিবর্তে ফর্ম-এনকোড করা isocode ফিল্ডটি পড়া হয়। ঐচ্ছিক pid কোয়েরি স্ট্রিংয়ে পাঠানো হয়।

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getstates/US'

প্রতিক্রিয়া

প্রচলিত মোড়ক কাঠামো। সফল হলে status.code হয় 200, status.msg খালি থাকে এবং status.results হয় এন্ট্রির সংখ্যা। response হলো প্রথমে name অনুযায়ী (বড় ও ছোট হাতের অক্ষরে পার্থক্য না করে), তারপর state কোড অনুযায়ী সাজানো তালিকা। ফিল্ডগুলো: state (প্রিফিক্সগুলোর অঙ্গরাজ্য-সংক্রান্ত তথ্য থেকে নেওয়া অঙ্গরাজ্য বা প্রদেশের কোড, সাধারণত দুটি অক্ষর; অপ্রচলিত মান অপরিবর্তিতভাবে ফেরত দেওয়া হয়); name (ক্যাটালগে থাকা নাম, অথবা ক্যাটালগে নাম না থাকলে কোড); country_iso; available (গণনায় ধরা প্রিফিক্সগুলোর মোট মজুত, সর্বদা 0-এর বেশি); prefix_count (গণনায় ধরা মজুত প্রিফিক্সের সংখ্যা); is_mobile (গণনায় ধরা কোনো প্রিফিক্স মোবাইল সেবা সমর্থন করলে 1; US-এর জন্য সর্বদা 0, যদি না আপনার অ্যাকাউন্টে যুক্তরাষ্ট্রের মোবাইল নম্বর ব্যবহারের অনুমতি সক্রিয় থাকে); sms_coverage (গণনায় ধরা কোনো প্রিফিক্সে SMS কভারেজ থাকলে 1); returns_numbers (গণনায় ধরা কোনো প্রিফিক্সে নম্বর ফেরত দেওয়ার ফ্ল্যাগ থাকলে অথবা ওই ফ্ল্যাগের কোনো মান না থাকলে 1); next_function ('v3/getareas/{isocode}?state={state}')। মজুতে প্রিফিক্স থাকলেও সেগুলোর কোনোটিতে অঙ্গরাজ্যের তথ্য না থাকলে ফলাফল হয় status.code 200, সঙ্গে একটি খালি তালিকা এবং status.results 0।

প্রতিক্রিয়ার কাঠামোর উদাহরণ; এটি অ্যাকাউন্টের তাৎক্ষণিক তথ্য বা বর্তমান মূল্যপ্রস্তাব নয়।

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

ত্রুটি

• 500: msg 'ISO Code parameter is required': isocode দেওয়া হয়নি বা খালি রয়েছে। এটি অনুরোধের একটি সংশোধনযোগ্য ত্রুটি। এর সঙ্গে মিলে যাওয়া HTTP স্ট্যাটাস সেট করা হয় না; status.code পড়ুন।
• 404: msg 'getstates is only available for US and CA': অন্য যেকোনো দেশের কোডের ক্ষেত্রে। এর সঙ্গে মিলে যাওয়া HTTP স্ট্যাটাস সেট করা হয় না।
• 404: msg 'No states found': দেশ ও উৎসের ফিল্টারের সঙ্গে মেলে এমন কোনো মজুত প্রিফিক্স নেই। এর সঙ্গে মিলে যাওয়া HTTP স্ট্যাটাস সেট করা হয় না।
• 401: পরিচয় যাচাইয়ের তথ্য নেই অথবা যাচাই ব্যর্থ হয়েছে। HTTP স্ট্যাটাস 401 দিয়ে পাঠানো হয়।

প্রাপ্যতা ও পার্শ্বপ্রভাব

• শুধু তথ্য অনুসন্ধান করে। এটি কোনো কিছু সংরক্ষণ, অর্ডার বা পরিবর্তন করে না। available শুধু তথ্য দেয় এবং নম্বর ধরে রাখে না।