REST API دستاویزات

LRN روٹنگ لُک اپ REST API

شمالی امریکہ کے ٹیلی فون نمبر کا روٹنگ نمبر اور دستیاب کیریئر کی معلومات ایک مقررہ قیمت پر معلوم کریں۔

اکاؤنٹ سے متعلق ریفرنس کھولیں ڈیولپر اور آٹومیشن

API اور اسناد کا انتخاب ایک ساتھ کریں

ڈیولپر اور آٹومیشن، کاروبار اور کمیونیکیشنز فراہم کنندگان کے منظور شدہ اکاؤنٹس فعال سروسز کو انٹیگریٹ کر سکتے ہیں۔ انفرادی ڈیولپر کو خود کو کمپنی ظاہر کرنے کی ضرورت نہیں۔ ایپلیکیشن SMS/MMS کے لیے متعلقہ بھیجنے کی منظوری اور رجسٹریشن درکار ہے۔ افراد اور خاندان کی سروس میں صارفین کے لیے پیغامات بھیجنے کا عمل شروع کرنے والا کوئی API موجود نہیں۔

API فیملی	بنیادی URL	تصدیق اور نتیجہ
Communications v3	`https://api.multitel.net/v3`	منظور شدہ Basic اسناد؛ اہل اور فراہم کردہ ٹوکن صرف ان آپریشنز کے لیے جو انہیں سپورٹ کرتے ہوں۔ JSON `status` اور `response`۔
ہنگامی کالنگ کے لیے رجسٹریشن	`https://api.multi.tel/emergency`	منظور شدہ Basic اسناد یا خاص طور پر فراہم کی گئی bearer رسائی۔ JSON `code`، `message` اور `data`۔
پورٹل REST انٹیگریشنز	ہوسٹ اور آپریشن، جیسا کہ آپ کے اکاؤنٹ کے ڈویلپر ریفرنس میں دکھایا گیا ہے	اس آپریشن کی دستاویزات میں درج اسناد، اجازت کے دائرے اور اسکیما استعمال کریں۔ براؤزر سیشن کی درخواستیں ایک الگ انٹرفیس استعمال کرتی ہیں۔

مثالیں استعمال کرنے سے پہلے MULTITEL_API_USERNAME اور MULTITEL_API_PASSWORD کو اپنے سرور کی خفیہ کنفیگریشن کے ذریعے سیٹ کریں۔ انہیں کبھی بھی عوامی براؤزر JavaScript، URLs یا سورس کنٹرول میں شامل نہ کریں۔ مخصوص اسناد کا انتظام API انضمام کی سیٹنگز میں کیا جاتا ہے۔

نمبر کی تلاش (lookup) کریں

GET /v3/lrn/{number} پاتھ میں منزل کا نمبر قبول کرتا ہے۔ کال کرنے والے نمبر پر منحصر معلومات کے لیے وہ نمبر اختیاری طور پر /v3/lrn/{number}/{ani} میں دیا جا سکتا ہے۔ شمالی امریکی فون نمبر صرف ہندسوں میں لکھیں اور جہاں لاگو ہو ملک کا کوڈ شامل کریں؛ مثالوں میں محفوظ فرضی نمبر استعمال کیے گئے ہیں۔

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123"

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123/12025550124"

درست اسناد کے ساتھ lookup چلانا قابلِ بل ہے۔ ریٹ $0.00025 فی lookup ہے: $0.25 فی 1,000 یا $250 فی ملین۔ حجم پر کوئی رعایت نہیں ہے۔ یہ روٹنگ کی معلومات کی تلاش ہے؛ اس سے ٹیلی فون کال نہیں کی جاتی۔

نتیجہ پڑھیں

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": {
    "lrn": "12025550123",
    "ported": 0,
    "ocn": "",
    "lata": "",
    "rc": "",
    "cost": "$0.00025"
  }
}

یہ گھڑی ہوئی مثال صرف جواب کی ساخت دکھاتی ہے؛ یہ ناپا گیا روٹنگ نتیجہ نہیں ہے۔ response استعمال کرنے سے پہلے status.code چیک کریں۔ cost فیلڈ کرنسی کے سابقے والی اسٹرنگ ہے، JSON نمبر نہیں۔

فیلڈ	مطلب
`lrn`	Location Routing Number، جو روٹنگ کی منزل کی شناخت کے لیے استعمال ہوتا ہے۔
`ported`	اس lookup کی فراہم کردہ اس بات کی نشاندہی کہ نمبر پورٹ ہوا ہے یا نہیں: عام طور پر 0 یا 1۔ اسے ملکیت یا سروس کی اہلیت کے ثبوت کے طور پر استعمال نہ کریں۔
`ocn`	Operating Company Number، جب فراہم کیا جائے۔
`lata`	Local Access and Transport Area، جب فراہم کیا جائے۔
`rc`	ریٹ سینٹر، جب فراہم کیا جائے۔
`city`, `state`, `lec`, `lectype`, `jurisdiction`, `local`	مقام، کیریئر یا origin سے متعلق اضافی تفصیلات، جب دستیاب ہوں۔ یہ غیر موجود یا خالی ہو سکتی ہیں۔

یہ ضروری نہ سمجھیں کہ ہر روٹنگ فیلڈ موجود ہو۔ خاص طور پر، ٹول فری نتائج میں مقامی ریٹ سینٹر اور کیریئر کوڈ کی تفصیلات شامل نہیں ہو سکتیں۔ واپس آنے والا LRN رسائی کی real-time ضمانت یا کال کے معیار کا ٹیسٹ نہیں ہے۔

اپنے روٹنگ ورک فلو میں lookups استعمال کریں

مطلوبہ نمبر بھیجنے سے پہلے اس کی توثیق کریں اور اسے معیاری شکل (normalize) دیں۔
HTTP اور ایپلیکیشن اسٹیٹس کا جائزہ لیں۔ مسئلے کی تشخیص کے لیے نمبر، وقت اور نتیجے کا حساس معلومات ہٹایا ہوا ریکارڈ رکھیں۔
صرف وہی فیلڈز استعمال کریں جو آپ کے روٹنگ اصول سے متعلق ہوں، اور غیر موجود قدروں کو واضح طور پر سنبھالیں۔
غیر یقینی جواب کے بعد دوبارہ کوششوں کو محدود رکھیں۔ lookup دہرانے سے دوبارہ چارج لگ سکتا ہے؛ اس endpoint کی کوئی دستاویزی idempotency key نہیں ہے۔

LRN پروڈکٹ اور فی تلاش یکساں قیمت دیکھیں۔ عوامی OpenAPI پاتھ میں ANI سیگمنٹ شامل ہے؛ تعینات شدہ LRN عمل درآمد ANI کے بغیر مختصر درخواست بھی قبول کرتا ہے۔ lrninfo ایک الگ آپریشن ہے اور اسے اس endpoint کی جگہ استعمال نہیں کرنا چاہیے۔

غلطیوں اور دوبارہ کوششوں کو سنبھالیں

تصدیق یا اجازت کی ناکامی: API اسناد کی فعال حالت، اجازت یافتہ سروس اور سورس IP کی پابندی چیک کریں۔ پورٹل سیشن کوکی انضمام کی اسناد نہیں ہے۔
ناکافی کریڈٹ یا نامکمل منظوری: آپریشن دوبارہ کرنے سے پہلے اکاؤنٹ بیلنس، بھیجنے کی منظوری یا دستاویز کی شرط کو پورا کریں۔
کوئی نتیجہ نہیں: خالی انوینٹری یا کالر کے نام کی عدم موجودگی کو ایک عام نتیجہ سمجھ کر سنبھالیں۔ یہ فرض نہ کریں کہ نحوی طور پر درست نمبر پر ہر سروس دستیاب ہے۔
نیٹ ورک ٹائم آؤٹ یا سروس کی ناکامی: پڑھنے (read) کے آپریشنز کے لیے backoff کے ساتھ محدود دوبارہ کوششیں استعمال کریں۔ خریداری، بھیجنے یا رجسٹریشن کے لیے پہلے آپریشن کی حالت دیکھیں؛ قبول شدہ درخواست کو دوبارہ بھیجنے سے قابلِ بل عمل دہرایا جا سکتا ہے۔

Idempotency کی سہولت ہر API فیملی کی اپنی ہوتی ہے۔ Emergency API دوبارہ کوشش کی کلیدیں (retry keys) سپورٹ کرتی ہے؛ اس کا مطلب یہ نہیں کہ کوئی بھی v3 درخواست idempotent ہے۔ سپورٹ کے لیے ٹائم اسٹیمپ، واپس آنے والی IDs اور حساس معلومات ہٹائے ہوئے جوابات محفوظ رکھیں۔

اپنے اکاؤنٹ کے ریفرنس کے ساتھ آگے بڑھیں

سائن اِن ریفرنس آپریشنز کو آپ کی اجازتوں اور فعال سروسز کے مطابق فلٹر کرتا ہے۔ اس کا درست ہوسٹ، اسناد کی قسم، درخواست کے فیلڈز اور رسپانس اسکیما استعمال کریں۔ کنسولز لائیو آپریشنز چلا سکتے ہیں، جن میں خریداریاں اور پیغامات بھی شامل ہیں۔

اکاؤنٹ کے مخصوص اینڈ پوائنٹس کی فہرست کمیونیکیشنز REST کنسول عوامی کمیونیکیشنز OpenAPI دستاویز OAuth انضمام کی گائیڈ