শুরু করার আগে
একটি এলাকা বেছে নিতে ব্যবহার করুন getareas। এলাকার ID কপি করুন এর উত্তরে পাওয়া তথ্য থেকে অথবা ফেরত দেওয়া next_function থেকে। US বা কানাডার কোনো এলাকার ক্ষেত্রে ব্যবহার করুন getstates যদি ফলাফল একটি রাজ্য বা প্রদেশের মধ্যে সীমিত করতে চান।
ফলাফল বুঝে নিন
পরীক্ষা করুন status.code যা JSON বডিতে থাকে, সেই সঙ্গে HTTP স্ট্যাটাসও পরীক্ষা করুন। সফল ফলাফল থাকে response অ্যারেতে। ডিফল্ট উত্তর নাম অনুসারে সাজানো থাকে। available একটি আনুমানিক মান, এবং ক্যাটালগের ফ্ল্যাগগুলি দেখে নির্বাচিত নম্বরের প্রকৃত সক্ষমতা ও নিবন্ধনের প্রয়োজনীয়তা যাচাই করার কাজ এড়ানো যায় না।
পরবর্তী ধাপ বেছে নিন
গ্রুপ করা হয়নি এমন ফলাফল ব্যবহার করুন। যখন returns_numbers এর মান 1 হয়, তখন ফেরত দেওয়া next_function নম্বর অনুসন্ধানের নির্দেশ দেয়। মান 0 হলে অর্ডারের সময় নম্বর বরাদ্দ করা হয় এবং পাথটি অর্ডার দেওয়ার একটি অপারেশনের নির্দেশ দেয়। অনুরোধ পাঠানোর আগে অপারেশনটি ও তার প্রয়োজনীয়তাগুলি পরীক্ষা করুন: অর্ডারের অনুরোধের ফলে আপনার অ্যাকাউন্টে চার্জ ধার্য হতে পারে। ফেরত দেওয়া প্রতিটি পাথে স্বয়ংক্রিয়ভাবে অনুরোধ পাঠাবেন না।
এখানে কোনো মূল্য অন্তর্ভুক্ত নেই। কেনার আগে প্রাসঙ্গিক মূল্যপ্রস্তাব, প্রয়োজনীয় নথি ও অর্ডারের নির্দেশাবলি পর্যালোচনা করুন। প্রদর্শিত টেলিফোন প্রিফিক্স থেকে ID তৈরি না করে ফেরত দেওয়া পৃথক প্রিফিক্সের ID ও মূল্যপ্রস্তাবের ID সংরক্ষণ করুন।
প্রদর্শনের উন্নত বিকল্পগুলি
compact=1 সর্বাধিক 100 সারির একটি এলোমেলোভাবে সাজানো নমুনা ফেরত দেয়, বড় কোনো ফলাফলসমষ্টির একটি পৃষ্ঠা নয়। গ্রুপ করলে সারসংক্ষেপের সারি ও কৃত্রিম ID তৈরি হয়; একটি পৃথক প্রিফিক্স বেছে নিতে সাধারণ, গ্রুপ করা হয়নি এমন উত্তর ব্যবহার করুন। নমুনাভিত্তিক বা গ্রুপ করা ফলাফল ব্যবহার করে সম্পূর্ণ মজুত বা সুনির্দিষ্ট সক্ষমতা সম্পর্কে দাবি করবেন না।
অনুরোধ
HTTPS-এর মাধ্যমে আপনার সক্রিয় API অ্যাকাউন্টের পরিচয়পত্র ব্যবহার করুন। Basic প্রমাণীকরণ এবং সক্রিয় API অ্যাকাউন্টের bearer টোকেন সমর্থিত; অ্যাকাউন্টের বিধিনিষেধ প্রযোজ্য।
GET ব্যবহার করুন এবং ঐচ্ছিক প্যারামিটারগুলি কোয়েরি স্ট্রিংয়ে পাঠান। বিকল্প ব্যবস্থা হিসেবে ফর্ম বডির ওপর নির্ভর করবেন না।
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| নাম | ধরন | আবশ্যক | বিবরণ |
|---|---|---|---|
area_id | string | হ্যাঁ | getareas অথবা এর next_function থেকে এলাকার শনাক্তকারী কপি করুন। এর অভ্যন্তরীণ গঠন ব্যাখ্যা না করে মানটি যেমন আছে তেমনই ব্যবহার করুন; নিজে এটি তৈরি করবেন না বা এর হ্যাশ গণনা করবেন না। |
| নাম | ধরন | আবশ্যক | বিবরণ |
|---|---|---|---|
state | string | না | শুধুমাত্র US ও CA-এর এলাকার জন্য। getstates থেকে পাওয়া রাজ্য/প্রদেশের কোড অথবা তার পুরো নাম ব্যবহার করুন। কোডে বড় ও ছোট হাতের অক্ষরের পার্থক্য ধরা হয় না; নামের ক্ষেত্রেও এই পার্থক্য এবং পরপর থাকা অতিরিক্ত ফাঁকা স্থান উপেক্ষা করা হয়। অন্য কোনো দেশ বা অচেনা অশূন্য মান দিলে API ত্রুটি ফেরত আসে। |
compact | string | না | ঐচ্ছিক নমুনা মোড: 1, true অথবা on। ফলাফল এলোমেলোভাবে সাজানো থাকে এবং সর্বাধিক 100 সারি থাকে। ফলাফলের সম্পূর্ণ তালিকা পেতে এই প্যারামিটারটি বাদ দিন; এই এন্ডপয়েন্টে পৃষ্ঠা/কার্সর নেই। |
group | integer | না | প্রদর্শনের উন্নত সারসংক্ষেপ: 1 থেকে 6 পর্যন্ত মান সারিগুলি একত্র করে এবং প্রদর্শনের জন্য আংশিক আড়াল করা প্রিফিক্স ফেরত দেয়। গ্রুপের UUID-গুলি কৃত্রিম এবং পৃথক প্রিফিক্সের ID-র পরিবর্তে ব্যবহার করা যায় না। নম্বর অনুসন্ধান বা অর্ডারের জন্য প্রিফিক্স বেছে নেওয়ার আগে গ্রুপ করা হয়নি এমন ফলাফলের অনুরোধ করুন। স্বাভাবিক কাজের ধারায় এই প্যারামিটারটি বাদ দিন। |
pid | string | না | MultiTEL প্রদত্ত ঐচ্ছিক মজুত নির্বাচক, যা সংখ্যার আকারে অথবা সমর্থিত 32 অক্ষরের হেক্সাডেসিমাল আকারে দেওয়া হয়। স্বাভাবিক ব্যবহারে এটি বাদ দিন। অচেনা মান কোনো বার্তা ছাড়াই উপেক্ষা করা হয়। এই মান ফোনের প্রিফিক্স বা মূল্য পরিকল্পনার ID নয়। |
উত্তর
প্রচলিত status/response JSON মোড়ক। status.results ফেরত দেওয়া সারির সংখ্যা গণনা করে, নমুনা নেওয়া বা গ্রুপ করার পরের সারিগুলিও এর অন্তর্ভুক্ত। response-এ প্রিফিক্স অবজেক্টগুলি থাকে। মূল্যের কোনো ফিল্ড ফেরত দেওয়া হয় না। সাধারণ, গ্রুপ করা হয়নি এমন উত্তরে uuid হলো প্রিফিক্সের ID; area_uuid ও country_uuid হলো ফেরত দেওয়া শনাক্তকারী; prefix ও name হলো প্রদর্শনের তথ্য; available প্রাপ্যতার আনুমানিক মান, সংরক্ষণ নয়; needs_registration ও restrictions নিবন্ধনসংক্রান্ত তথ্য বর্ণনা করে; sms_coverage, is_mobile ও number_type ক্যাটালগের ইঙ্গিতমাত্র, কোনো নির্দিষ্ট নম্বরের সক্ষমতার নিশ্চয়তা নয়। number_type খালি থাকতে পারে অথবা ক্যাটালগের অন্য কোনো স্ট্রিং হতে পারে, তাই নির্দিষ্ট কয়েকটি মানের এনামের বাধ্যবাধকতা আরোপ করবেন না। state একটি স্ট্রিং এবং এটি খালি থাকতে পারে অথবা ক্যাটালগের বিন্যাসে লেখা থাকতে পারে। latitude ও longitude খালি থাকতে পারে। metered ও overflow ক্যাটালগের ফ্ল্যাগ, অর্থের পরিমাণ নয়। returns_numbers নম্বরের তালিকা পাওয়ার রুট (1) অথবা অর্ডারের সময় নম্বর বরাদ্দের রুট (0) বেছে নেয়। next_function সেই পরবর্তী রুটটি শনাক্ত করে। গ্রুপ করা উত্তরে অতিরিক্তভাবে একত্রিত বৈশিষ্ট্য থাকে, যার মধ্যে বিকল্প হিসেবে ব্যবহৃত বৈশিষ্ট্যের মানও অন্তর্ভুক্ত; এগুলিকে প্রতিটি নম্বরের যাচাইকৃত সক্ষমতা বলে ধরে নেবেন না।
উত্তরের কাঠামো বোঝানোর উদাহরণ; এটি অ্যাকাউন্টের সরাসরি তথ্য বা বর্তমান মূল্যপ্রস্তাব নয়।
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}ত্রুটি
- 404: Invalid area ID: অনুসন্ধানের ধাপ থেকে বর্তমান এলাকার ID সংগ্রহ করুন।
- 404: State filter is only available for US and CA: অন্য দেশের জন্য state বাদ দিন।
- 404: Invalid state: এই দেশের জন্য getstates থেকে ফেরত দেওয়া রাজ্য/প্রদেশ ব্যবহার করুন।
- 404: No prefixes found: ক্যাটালগের কোনো মিলে যাওয়া সারি ফেরত আসেনি। এর অর্থ এই নয় যে কোনো নির্দিষ্ট নম্বর কখনোই অর্ডার করা যাবে না।
- 500: ত্রুটি: 'Failed loading prefixes': ক্যাটালগে খোঁজা ব্যর্থ হয়েছে। পরে আবার চেষ্টা করুন এবং সমস্যা চলতে থাকলে সহায়তা বিভাগের সঙ্গে যোগাযোগ করুন।
প্রাপ্যতা ও পার্শ্বপ্রতিক্রিয়া
- এটি অনুসন্ধানের ধাপ, অর্ডারের নিশ্চয়তা নয়। ক্যাটালগে আরও খোঁজ করে প্রাপ্যতার তথ্য হালনাগাদ করা হতে পারে, তাই উত্তর আসার সময় কমবেশি হতে পারে।
- মূল্য ফেরত দেওয়া হয় না। অর্ডার দেওয়ার আগে সংশ্লিষ্ট নম্বর বা অর্ডারের মূল্যপ্রস্তাব সংগ্রহ করুন এবং নিবন্ধনের প্রয়োজনীয়তাগুলি পর্যালোচনা করুন।
- available-কে মজুতের সঠিক সংখ্যা, শূন্যকে সব ক্ষেত্রে অর্ডার দেওয়ার নিষেধাজ্ঞা অথবা সফল অনুসন্ধানকে সংরক্ষণ বলে ধরে নেবেন না। অর্ডার দেওয়ার আগে প্রাপ্যতা বদলে যেতে পারে।