اکاؤنٹ اور منصوبے تک رسائی
اجازت یافتہ IP پتے سے HTTPS کے ذریعے فعال API اکاؤنٹ استعمال کریں۔ منصوبہ اسی اکاؤنٹ کی ملکیت ہونا چاہیے اور حذف شدہ نہیں ہونا چاہیے۔ نمبر منتقلی کے آرڈر کے عمل سے حاصل کردہ منصوبے کی منفرد شناخت استعمال کریں، اس کی عددی ڈیٹابیس شناخت یا فون نمبر نہیں۔ درخواست بناتے وقت منصوبے کی شناخت کو URL انکوڈ کریں۔
درخواست
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"اس جواب کو خفیہ معلومات سمجھ کر سنبھالیں
مکمل جواب میں اس ٹیلی کام کمپنی کی بلنگ معلومات شامل ہوتی ہیں جس سے نمبر منتقل ہو رہے ہیں، جن میں محفوظ کردہ billing_pin, بلنگ اکاؤنٹ، فون، پتے، کمپنی اور مجاز رابطہ شخص کی تفصیلات شامل ہیں۔ API ان خانوں کو نہیں چھپاتا۔ اگر آپ کے طریقۂ کار کو صرف کیفیت یا نمبروں کی فہرست درکار ہو تو صرف وہی طلب کریں۔ مکمل تفصیلی جواب کو براؤزر کے ذخیرے، تجزیاتی نظاموں، عوامی لاگز اور معاونت کے لیے بنائے گئے اسکرین شاٹس میں شامل نہ کریں، اور صرف وہ خانے ظاہر کریں جن کی مجاز صارف کو ضرورت ہو۔
جواب کی ساخت
منتخب خانوں کی فرضی مثال؛ جواب میں مزید خانے بھی آ سکتے ہیں۔
{
"status": {
"code": 200,
"msg": "Project Detail"
},
"response": {
"project": {
"id": 11,
"uniqueid": "PROJECT_EXAMPLE",
"project_name": "Example transfer",
"location": "US",
"status": 0,
"status_str": "Pending"
},
"counts": {
"total": 0,
"pending": 0,
"in_progress": 0,
"completed": 0,
"rejected": 0
},
"numbers": [],
"events": [],
"uploads": []
}
}جان بوجھ کر نامکمل رکھی گئی اس مثال میں بلنگ کی تمام تصدیقی معلومات اور ذاتی رابطے کی تمام قدریں چھوڑ دی گئی ہیں۔ مثال میں ان کی عدم موجودگی کا مطلب یہ نہیں کہ حقیقی جواب میں انہیں چھپا دیا جاتا ہے۔
| حصہ | مندرجات |
|---|---|
| project | ریکارڈ کی عددی شناخت، منصوبے کی منفرد شناخت، منصوبے کا نام، مقام، محفوظ کردہ بلنگ، رابطے اور پتے کا ڈیٹا، تخلیق کا وقت اور حساب سے اخذ کردہ کیفیت۔ اس کمپنی کے پرانے خانے کا نام جس سے نمبر منتقل ہو رہے ہیں، loosing_carrier لکھا جاتا ہے۔ |
| counts | فون نمبروں کے ریکارڈز کی کل تعداد اور Pending، In Progress، Completed اور Rejected کی گنتیاں۔ |
| numbers | نمبروں کے ڈیٹا کی وہی پیشکش جو منصوبے کے نمبروں کی فہرست والا اینڈ پوائنٹ فراہم کرتا ہے، جس میں صارف کے تبصرے اور محفوظ کردہ شیڈول کی قدریں بھی شامل ہیں۔ |
| events | محفوظ کردہ واقعات کے ریکارڈز اور پے لوڈ کے خام یا تجزیہ شدہ خانے، جو واقعات والے اینڈ پوائنٹ کی مرئیت اور وضع کی حدود کے تابع ہیں۔ |
| uploads | دستاویزات کا میٹا ڈیٹا: عددی شناخت، upload_type، file_name، file_extension، date_created اور ایک نسبتی download_url۔ اس ویب پتے کے لیے بھی اکاؤنٹ کی تصدیق ضروری ہے۔ |
خلاصے اور میٹا ڈیٹا کو سمجھیں
اخذ کردہ کیفیت میں پہلے In Progress، پھر Pending، پھر Completed اور پھر Rejected کو ترجیح دی جاتی ہے؛ کوئی صورت لاگو نہ ہو تو Pending استعمال ہوتا ہے۔ خلاصے کی کیفیت Completed ہونے کے باوجود کچھ نمبر مسترد شدہ ہو سکتے ہیں۔ یہ فرض کرنے کے بجائے کہ ہر نمبر کی منتقلی مکمل ہو گئی ہے، گنتیوں اور نمبروں کی کیفیتیں دیکھیں۔
جواب میں دستاویزات کا میٹا ڈیٹا ہوتا ہے، فائلوں کے بائٹس نہیں۔ اس میں صفحہ بندی یا تدریجی قرأت کے لیے کرسر موجود نہیں۔ تفصیلات اور فہرست کی استفساری درخواستیں ڈیٹا الگ الگ پڑھتی ہیں؛ یہ ایک ہی ایسا عکس نہیں جس کی معاملاتی یکسانیت کی ضمانت ہو۔ تاریخیں اپنی محفوظ کردہ قدروں میں رہتی ہیں اور زمانی علاقے کی کوئی دستاویزی تبدیلی نہیں کی جاتی۔ منصوبے کے راستوں کے لیے uniqueid استعمال کریں؛ منصوبے کی عددی شناخت اس کے متبادل کے طور پر استعمال نہیں ہو سکتی۔
خرابیاں اور حدود
HTTP جواب کے ساتھ یہ قدریں بھی جانچیں: status.code/status.msg۔ غیر موجود، حذف شدہ یا اکاؤنٹ کی ملکیت میں نہ ہونے والے منصوبے کے لیے API کوڈ 404 اور منصوبہ نہ ملنے کا پیغام واپس آتا ہے۔ تصدیق اور ماخذ IP کی پابندیاں بھی لاگو ہوتی ہیں۔ مثالیں حقیقی درخواست نہیں بھیجتیں، اور کامیاب جواب اس بات کا ثبوت نہیں کہ کسی ٹیلی کام کمپنی نے منتقلی قبول یا مکمل کر لی ہے۔
اثرات اور طریقۂ کار
یہ تفصیلات کا معیاری راستہ ہے جسے موجودہ پورٹل میں نمبر منتقلی کے آرڈر کا منظر استعمال کرتا ہے۔ پورٹل اپنے صارف انٹرفیس کے لیے خانوں کی نقشہ بندی کرتا ہے اور صارف کے لیے ڈیٹا کی اپنی پیشکش بناتا ہے؛ یہ فرض نہ کریں کہ خام API جواب پورٹل کے JSON یا اس کی ظاہری پیشکش جیسا ہی ہے۔ تفصیلات سنبھالنے والا زیر جائزہ جزو منصوبے میں تبدیلی نہیں کرتا، نہ ہی براہ راست ٹیلی کام کمپنی کو درخواست بھیجنے یا چارج عائد کرنے کا عمل شروع کرتا ہے۔