একটি দেশের কভারেজ এলাকার তালিকা দেখুন

একটি দেশ বেছে নেওয়ার পর (এবং যুক্তরাষ্ট্র বা কানাডার ক্ষেত্রে, চাইলে একটি রাজ্য বেছে নিতে ব্যবহার করুন getstates), কল করুন getareas এবং দেখুন কোন কোন এলাকায় নম্বর দেওয়া হয়। এলাকার শনাক্তকারী uuid পরবর্তী ধাপের জন্য রেখে দিন।

প্রতিটি এলাকার জন্য পরবর্তী ধাপ এই দুটির একটি:

• available > 0: next_function-এর মান হয় v3/getprefixes/{uuid}, যার সঙ্গে ?state= যোগ করা হয় যদি আপনি রাজ্য অনুযায়ী ফিল্টার করে থাকেন। প্রিফিক্সগুলি দেখতে এটি ব্যবহার করুন।
• available = 0: এলাকায় প্রিফিক্স আছে কিন্তু মজুত নেই, এবং next_function-এর মান হয় v3/order/{uuid}। এই ধাপে কী কী প্রয়োজন তা জানতে অর্ডার করার নির্দেশিকা দেখুন।

available হলো পুরো এলাকার মোট মজুত, এমনকি আপনি রাজ্য অনুযায়ী ফিল্টার করলেও। রাজ্যভিত্তিক ফিল্টারে কোড বা পুরো নাম দেওয়া যায়, তবে এটি শুধু US ও CA-এর জন্য কাজ করে। রাজ্যভিত্তিক ফিল্টার ব্যবহার করে যদি এই বার্তাটি পান: No areas found, তাহলে ওই ফিল্টার ছাড়া আবার চেষ্টা করুন। এই ক্রমে যাচাই করা হয়: দেশের কোড অনুপস্থিত, অজানা দেশ, অন্য দেশের জন্য রাজ্যভিত্তিক ফিল্টার, অবৈধ রাজ্য, কোনো মিলে যাওয়া এলাকা নেই। এর প্রতিটি ক্ষেত্রে ফেরত দেওয়া কোড হয় 500 অথবা 404 এই ফিল্ডে: status.code, তবে তার সঙ্গে সঙ্গতিপূর্ণ HTTP স্ট্যাটাস দেওয়া হয় না।

অনুরোধ

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

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

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getareas/US'
curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getareas/US?state=NY'

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

প্রচলিত প্রতিক্রিয়া কাঠামো। সফল হলে status.code হয় 200, status.msg হয় 'Results: N', status.results হয় N, এবং response হয় এলাকার নাম অনুযায়ী সাজানো একটি তালিকা। ফিল্ডগুলি: uuid (পরবর্তী ধাপে ব্যবহৃত এলাকার শনাক্তকারী, যার গঠন থেকে অর্থ বোঝার প্রয়োজন নেই); country_uuid (দেশের 32 অক্ষরের শনাক্তকারী, যার গঠন থেকে অর্থ বোঝার প্রয়োজন নেই এবং যা পরে আর লাগে না); name; area_type ও number_type (ক্যাটালগের বর্ণনামূলক তথ্য; তালিকাভুক্ত ধরনগুলি যে স্থানীয় নম্বরের ধরনই হবে, তা নয়); country_iso; is_mobile (0 অথবা 1, এলাকার মোবাইল ফ্ল্যাগ থেকে নেওয়া; US-এর জন্য সর্বদা 0 থাকে, যদি না আপনার অ্যাকাউন্টে US-এর মোবাইল নম্বর ব্যবহারের সুবিধা সক্রিয় থাকে); available (এলাকার মিলে যাওয়া সব প্রিফিক্সের মোট মজুত, অনুরোধে নির্দিষ্ট রাজ্যে সীমাবদ্ধ নয়); sms_coverage (0 অথবা 1); returns_numbers (0 অথবা 1, এলাকার প্রিফিক্সগুলির মধ্যে সর্বোচ্চ ফ্ল্যাগের মান); latitude ও longitude; state_iso; next_function। state_iso: রাজ্যভিত্তিক ফিল্টার থাকলে এটি ফিল্টার থেকে নির্ধারিত কোড। US ও CA-এর ক্ষেত্রে ফিল্টার না থাকলে, যে রাজ্যের নাম এলাকার নামের সমান তার কোড ব্যবহার করা হয়; তা না পাওয়া গেলে এলাকার সংরক্ষিত মান, সেটিও না থাকলে এলাকার প্রিফিক্সের তথ্য থেকে নির্ণয় করা কোড ব্যবহার করা হয়। অন্য দেশগুলির ক্ষেত্রে এটি সংরক্ষিত মান এবং খালি থাকতে পারে। next_function-এর মান হয় 'v3/getprefixes/{uuid}' (ফিল্টার করা হলে সঙ্গে '?state={code}' যোগ হয়) যখন available-এর মান 0-এর বেশি, অন্যথায় 'v3/order/{uuid}'। যেসব এলাকায় একটিও মিলে যাওয়া প্রিফিক্স নেই সেগুলি বাদ দেওয়া হয়। যেসব এলাকায় প্রিফিক্স আছে কিন্তু মজুত নেই সেগুলি ফেরত দেওয়া হয়, এবং সেখানে available-এর মান থাকে 0।

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

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "uuid": "0000000000000000000000000000a001",
      "country_uuid": "0000000000000000000000000000c001",
      "name": "Example City",
      "area_type": "City",
      "number_type": "Local",
      "country_iso": "US",
      "is_mobile": 0,
      "available": 58,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "latitude": "40.0000",
      "longitude": "-75.0000",
      "state_iso": "NY",
      "next_function": "v3/getprefixes/0000000000000000000000000000a001"
    },
    {
      "uuid": "0000000000000000000000000000a002",
      "country_uuid": "0000000000000000000000000000c001",
      "name": "Sample Town",
      "area_type": "City",
      "number_type": "Local",
      "country_iso": "US",
      "is_mobile": 0,
      "available": 0,
      "sms_coverage": 0,
      "returns_numbers": 0,
      "latitude": "41.0000",
      "longitude": "-76.0000",
      "state_iso": "PA",
      "next_function": "v3/order/0000000000000000000000000000a002"
    }
  ]
}

ত্রুটি

• 500: msg 'ISO Code parameter is required': isocode অনুপস্থিত বা খালি। এটি অনুরোধের একটি সংশোধনযোগ্য ত্রুটি। এর সঙ্গে সঙ্গতিপূর্ণ কোনো HTTP স্ট্যাটাস সেট করা হয় না।
• 404: msg 'Error: no such country': দেশের কোডটি অপরিচিত। এর সঙ্গে সঙ্গতিপূর্ণ কোনো HTTP স্ট্যাটাস সেট করা হয় না।
• 404: msg 'State filter is only available for US and CA': অন্য একটি দেশের জন্য state-এ খালি নয় এমন মান পাঠানো হয়েছে। এর সঙ্গে সঙ্গতিপূর্ণ কোনো HTTP স্ট্যাটাস সেট করা হয় না।
• 404: msg 'Invalid state': state ওই দেশের পরিচিত কোডও নয়, পরিচিত নামও নয়। এর সঙ্গে সঙ্গতিপূর্ণ কোনো HTTP স্ট্যাটাস সেট করা হয় না।
• 404: msg 'No areas found': দেশ, উৎস ও রাজ্যভিত্তিক ফিল্টারগুলির সঙ্গে কোনো এলাকা মেলে না। এর সঙ্গে সঙ্গতিপূর্ণ কোনো HTTP স্ট্যাটাস সেট করা হয় না।
• 401: পরিচয় যাচাইয়ের তথ্য অনুপস্থিত অথবা পরিচয় যাচাই ব্যর্থ হয়েছে। HTTP স্ট্যাটাস 401 সহ পাঠানো হয়।

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

• শুধু গ্রাহক অ্যাকাউন্টের জন্য তথ্য অনুসন্ধান করে। এটি কোনো কিছু সংরক্ষণ, অর্ডার বা পরিবর্তন করে না।
• available শুধু তথ্য জানানোর জন্য এবং পরবর্তী ধাপের আগেই এর মান বদলে যেতে পারে।