ڈیولپرز

GET/v3/getprefixes/{area_id}

کسی علاقے کے نمبر سابقوں کی فہرست حاصل کریں

کسی علاقے کے لیے پیش کردہ نمبر سابقوں کی فہرست حاصل کریں، دستیابی اور رجسٹریشن کے اشاریے دیکھیں، اور معلومات کی تلاش یا آرڈر دینے کا اگلا مرحلہ معلوم کریں۔ قیمتیں شامل نہیں ہیں۔

اس صفحے پر
  1. شروع کرنے سے پہلے
  2. نتیجہ پڑھیں
  3. اگلا مرحلہ منتخب کریں
  4. نمائش کے جدید اختیارات
  5. درخواست
  6. جواب
  7. خرابیاں
  8. دستیابی اور ضمنی اثرات

شروع کرنے سے پہلے

علاقہ منتخب کرنے کے لیے getareas استعمال کریں۔ علاقے کی شناخت اس کے جواب یا واپس ملنے والے next_function سے نقل کریں۔ امریکی یا کینیڈین علاقے کے لیے getstates استعمال کریں اگر آپ نتائج کو کسی ایک ریاست یا صوبے تک محدود کرنا چاہتے ہیں۔

نتیجہ پڑھیں

JSON باڈی میں status.code کو HTTP اسٹیٹس کے ساتھ جانچیں۔ کامیاب نتائج response کی صف میں ہوتے ہیں۔ طے شدہ جواب نام کے لحاظ سے ترتیب دیا جاتا ہے۔ available ایک تخمینہ ہے، اور کیٹلاگ کے اشاریے منتخب نمبر کی حقیقی صلاحیتوں اور رجسٹریشن کے تقاضوں کی جانچ کا متبادل نہیں ہیں۔

اگلا مرحلہ منتخب کریں

ایسا نتیجہ استعمال کریں جس کی گروہ بندی نہ کی گئی ہو۔ جب returns_numbers کی قدر 1 ہو تو واپس ملنے والا next_function نمبر تلاش کرنے کی کارروائی کی طرف اشارہ کرتا ہے۔ جب اس کی قدر 0 ہو تو نمبر آرڈر دیتے وقت مختص کیے جاتے ہیں اور راستہ آرڈر دینے کی کارروائی کی طرف اشارہ کرتا ہے۔ درخواست بھیجنے سے پہلے اس کارروائی اور اس کے تقاضوں کا جائزہ لیں: آرڈر کی درخواست سے آپ کے اکاؤنٹ پر رقم واجب ہو سکتی ہے۔ واپس ملنے والے ہر راستے پر خودکار طور پر درخواست نہ بھیجیں۔

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

نمائش کے جدید اختیارات

compact=1 زیادہ سے زیادہ 100 قطاروں کا بے ترتیب نمونہ واپس کرتا ہے، کسی بڑے مجموعۂ نتائج کا ایک صفحہ نہیں۔ گروہ بندی سے خلاصے کی قطاریں اور مصنوعی شناختیں بنتی ہیں؛ انفرادی سابقہ منتخب کرنے کے لیے عام، بغیر گروہ بندی والا جواب استعمال کریں۔ نمونے یا گروہ بندی والے نتائج کی بنیاد پر مکمل دستیاب ذخیرے یا قطعی صلاحیتوں کا دعویٰ نہ کریں۔

درخواست

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_idstringہاںعلاقے کی شناخت getareas یا اس کے next_function سے نقل کریں۔ اسے ایک ایسی قدر سمجھیں جس کی اندرونی ساخت سے کوئی مطلب اخذ نہ کیا جائے؛ اسے خود نہ بنائیں اور نہ اس کا ہیش تیار کریں۔
استفساری پیرامیٹر
نامقسملازمیتفصیل
statestringنہیںصرف US اور CA کے علاقوں کے لیے۔ getstates سے ریاست یا صوبے کا کوڈ، یا اس کا پورا نام استعمال کریں۔ کوڈ میں بڑے اور چھوٹے حروف کا فرق نہیں کیا جاتا؛ ناموں میں بھی یہ فرق اور بار بار آنے والی خالی جگہیں نظر انداز کی جاتی ہیں۔ کوئی دوسرا ملک یا کوئی غیر خالی قدر جسے پہچانا نہ جا سکے، API کی خرابی واپس کرتی ہے۔
compactstringنہیںنمونہ حاصل کرنے کا اختیاری طریقہ: 1، true یا on۔ نتائج بے ترتیب ہوتے ہیں اور ان میں زیادہ سے زیادہ 100 قطاریں ہوتی ہیں۔ نتائج کی مکمل فہرست کے لیے یہ پیرامیٹر نہ بھیجیں؛ اس اینڈپوائنٹ میں صفحہ یا کرسر نہیں ہے۔
groupintegerنہیںنمائش کے جدید خلاصے: 1 سے 6 تک کی قدریں قطاروں کو یکجا کرتی ہیں اور دکھانے کے لیے جزوی طور پر چھپائے گئے سابقے واپس کرتی ہیں۔ گروہوں کے UUID مصنوعی ہوتے ہیں اور انفرادی سابقوں کی شناختوں کی جگہ استعمال نہیں کیے جا سکتے۔ نمبر تلاش کرنے یا آرڈر دینے کے لیے سابقہ منتخب کرنے سے پہلے بغیر گروہ بندی کی درخواست بھیجیں۔ معمول کے طریقۂ کار میں یہ پیرامیٹر نہ بھیجیں۔
pidstringنہیںMultiTEL کی فراہم کردہ، دستیاب ذخیرہ منتخب کرنے کی اختیاری قدر، جو عددی یا معاونت یافتہ 32 حروف کی ہیکساڈیسیمل صورت میں ہوتی ہے۔ معمول کے استعمال میں اسے نہ بھیجیں۔ غیر شناخت شدہ قدریں بغیر کسی اطلاع کے نظر انداز کر دی جاتی ہیں۔ یہ قدر فون کا سابقہ یا قیمت کے منصوبے کی شناخت نہیں ہے۔

جواب

معیاری status/response JSON کا بیرونی ڈھانچا۔ status.results واپس آنے والی قطاروں کی تعداد بتاتا ہے، جن میں نمونہ لینے یا گروہ بندی کے بعد کی قطاریں بھی شامل ہیں۔ response میں سابقوں کے آبجیکٹ ہوتے ہیں۔ قیمت کا کوئی فیلڈ واپس نہیں کیا جاتا۔ عام، بغیر گروہ بندی والے جواب میں uuid سابقے کی شناخت ہے؛ 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: معلومات کی تلاش کے مرحلے سے علاقے کی موجودہ شناخت حاصل کریں۔
  • 404: State filter is only available for US and CA: دوسرے ممالک کے لیے state نہ بھیجیں۔
  • 404: Invalid state: اس ملک کے لیے getstates سے واپس ملنے والی ریاست یا صوبہ استعمال کریں۔
  • 404: No prefixes found: کیٹلاگ کی کوئی مطابقت رکھنے والی قطار واپس نہیں ملی۔ اس سے یہ ثابت نہیں ہوتا کہ کسی خاص نمبر کا آرڈر کبھی نہیں دیا جا سکتا۔
  • 500: خرابی: 'Failed loading prefixes': کیٹلاگ میں تلاش ناکام ہو گئی۔ بعد میں دوبارہ کوشش کریں اور مسئلہ برقرار رہے تو معاونت سے رابطہ کریں۔

دستیابی اور ضمنی اثرات

  • یہ معلومات کی تلاش کا مرحلہ ہے، آرڈر کی تصدیق نہیں۔ کیٹلاگ میں مزید تلاش کے ذریعے دستیابی کی معلومات تازہ کی جا سکتی ہیں، اس لیے جواب آنے میں لگنے والا وقت بدل سکتا ہے۔
  • قیمتیں واپس نہیں کی جاتیں۔ آرڈر دینے سے پہلے متعلقہ نمبر یا آرڈر کے لیے قیمت کی پیشکش حاصل کریں اور رجسٹریشن کے تقاضوں کا جائزہ لیں۔
  • available کو دستیاب ذخیرے کی قطعی تعداد، صفر کو ہر صورت آرڈر دینے کی ممانعت، یا کامیاب تلاش کو ریزرویشن نہ سمجھیں۔ آرڈر دینے سے پہلے دستیابی بدل سکتی ہے۔