ڈیولپرز

GET/v3/getcountries

ان ممالک کی فہرست جن کے نمبر اسٹاک میں موجود ہیں

وہ قابلِ نمائش ممالک واپس کرتا ہے جن کے کم از کم ایک نمبر سابقے کے لیے اس وقت اسٹاک موجود ہے۔ ہر اندراج میں کالنگ کوڈ، ISO کوڈ، ملک کی سطح پر موبائل اور SMS کے اشاریے، جغرافیائی نقاط اور ملک کے کوریج علاقوں تک جانے والا next_function لنک شامل ہوتا ہے۔

اس صفحے پر
  1. درخواست
  2. جواب
  3. خرابیاں
  4. دستیابی اور ضمنی اثرات

مقامی نمبروں کی تلاش یہاں سے شروع کریں۔ فہرست میں صرف وہ ممالک شامل ہیں جن کے نمبر اس وقت اسٹاک میں موجود ہیں۔ اس سے کوئی چیز محفوظ نہیں ہوتی۔

  • یہ قدر دیں: isocode، اس کو: getareas، یا getstates (صرف US اور CA کے لیے)، یا other کو۔
  • next_function ہمیشہ اس کی طرف اشارہ کرتا ہے: v3/getareas/{isocode}۔ ریاستہائے متحدہ اور کینیڈا کے لیے آپ getstates کو پہلے کال کر سکتے ہیں تاکہ نتائج کو ریاست یا صوبے کے لحاظ سے محدود کیا جا سکے۔
  • is_mobile اور sms_coverage ملک کی سطح کے اشاریے ہیں، ہر نمبر کے لیے ضمانت نہیں۔ ریاستہائے متحدہ کے لیے، is_mobile کی قدر ہوتی ہے: 0، سوائے اس صورت کے جب آپ کے اکاؤنٹ میں ریاستہائے متحدہ کے موبائل نمبروں کی سہولت فعال ہو۔
  • وہ ممالک فہرست میں شامل نہیں ہوتے جہاں کوریج صرف آرڈر پر دستیاب ہو۔ فہرست میں شامل نہ ہونے والے ملک کے لیے بھی آپ getareas یا other کو براہِ راست کال کر سکتے ہیں۔
  • اگر آپ کو کسی خاص ترتیب کی ضرورت ہو تو فہرست کو خود ترتیب دیں۔

اگر کوئی ملک شرائط پر پورا نہ اترے تو response کی قدر ہوتی ہے: null اور status.code کی قدر ہوتی ہے: 200۔

درخواست

درکار: HTTP Basic یا Bearer ٹوکن (شناخت کی توثیق اور API کے جوابات دیکھیں)۔ شناخت کی توثیق ناکام ہونے پر تلاش شروع ہونے سے پہلے HTTP 401 کے ساتھ جواب دیا جاتا ہے۔

GET، بغیر درخواست کے متن کے۔ واحد پیرامیٹر اختیاری pid ہے، جو کوئری اسٹرنگ میں بھیجا جاتا ہے۔

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
کوئری پیرامیٹرز
نامقسملازمیتفصیل
pidstringنہیںاعلیٰ درجے کی ترتیب کے لیے اور اختیاری۔ فہرست کو ان ممالک تک محدود کرتا ہے جنہیں اسٹاک کے کسی ایک ماخذ کے لیے نشان زد کیا گیا ہو۔ صرف MultiTEL کی فراہم کردہ قدر استعمال کریں، جو عددی صورت میں یا 32 حروف پر مشتمل ہیکساڈیسیمل صورت میں ہو، اور عام استعمال میں اسے شامل نہ کریں۔ pid جواب کی تفصیل میں بیان کردہ اسٹاک کی جانچ کو محدود نہیں کرتا۔ غیر شناخت شدہ قدریں، صفر، اور وہ قدریں جنہیں یہ اینڈپوائنٹ قبول نہیں کرتا، کسی خرابی کے بغیر نظر انداز کر دی جاتی ہیں؛ ایسی صورت میں فہرست تمام معاونت یافتہ ماخذوں کا احاطہ کرتی ہے۔

جواب

جواب کا معیاری بیرونی ڈھانچا۔ کامیابی کی صورت میں status.code کی قدر 200، status.msg کی قدر 'Results: N'، اور status.results کی قدر N ہوتی ہے، جبکہ response ممالک کی فہرست ہوتی ہے جس کی ترتیب کی کوئی ضمانت نہیں۔ فیلڈز: countrycode (ملک کا کالنگ کوڈ، '+' کے بغیر)؛ name (ملک کا نام)؛ description (وہی قدر جو name کی ہے)؛ isocode (ISO 3166-1 alpha-2 کوڈ)؛ is_mobile (0 یا 1، کیٹلاگ میں ملک کی سطح کا اشاریہ، جس کی قدر US کے لیے ہمیشہ 0 ہوتی ہے، سوائے اس صورت کے جب آپ کے اکاؤنٹ میں US کے موبائل نمبروں کی سہولت فعال ہو)؛ sms_coverage (0 یا 1، کیٹلاگ میں ملک کی سطح کا اشاریہ)؛ latitude اور longitude (ملک کے جغرافیائی نقاط)؛ next_function ('v3/getareas/{isocode}')۔ کوئی ملک صرف اسی صورت میں فہرست میں شامل ہوتا ہے جب وہ قابلِ نمائش ہو اور اس کے کم از کم ایک سابقے کے لیے اسٹاک کے کسی بھی ماخذ میں اس وقت اسٹاک موجود ہو۔ وہ ممالک شامل نہیں ہوتے جن کی پوری کوریج صرف آرڈر پر دستیاب ہو (اسٹاک موجود نہ ہو)۔ اسٹاک کی یہ جانچ ان فلٹرز سے زیادہ وسیع ہے جو getareas لاگو کرتا ہے، اس لیے فہرست میں شامل کسی ملک کے لیے بھی وہاں کبھی کبھار 'No areas found' واپس آ سکتا ہے۔ اگر کوئی ملک شرائط پر پورا نہ اترے تو status.code کی قدر 200 اور status.msg کی قدر 'Results: 0' ہوتی ہے، status.results فیلڈ موجود نہیں ہوتی، اور response کی قدر null ہوتی ہے۔

یہ جواب کی ساخت کی ایک مثال ہے؛ یہ اکاؤنٹ کا براہِ راست ڈیٹا یا موجودہ قیمت کی پیش کش نہیں ہے۔

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

خرابیاں

  • 401: شناخت کی توثیق موجود نہیں یا ناکام ہو گئی ہے۔ HTTP اسٹیٹس 401 کے ساتھ بھیجا جاتا ہے (شناخت کی توثیق اور API کے جوابات دیکھیں)۔

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

  • صرف معلومات کی تلاش کے لیے ہے۔ اس سے نہ کوئی چیز محفوظ ہوتی ہے، نہ کوئی آرڈر دیا جاتا ہے، اور نہ ہی کوئی تبدیلی ہوتی ہے۔
  • نتائج درخواست کے وقت موجود اسٹاک کی عکاسی کرتے ہیں اور ایک کال سے دوسری کال کے درمیان بدل سکتے ہیں۔