المطوّرون

GET/v3/getcountries

عرض البلدان التي تتوفر فيها أرقام في المخزون

يعيد البلدان الظاهرة التي لديها حاليًا بادئة أرقام واحدة على الأقل متاحة في المخزون. يتضمن كل إدخال رمز الاتصال ورمز ISO ومؤشرات الجوال والرسائل القصيرة على مستوى البلد والإحداثيات ورابط 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 (راجع المصادقة واستجابات واجهة برمجة التطبيقات). عند فشل المصادقة، تُرسل استجابة 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، مؤشر في الدليل على مستوى البلد، وتكون قيمته دائمًا 0 لـ US ما لم يكن حسابك مفعّلًا لاستخدام أرقام الجوال في 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 (راجع المصادقة واستجابات واجهة برمجة التطبيقات).

التوفر والآثار الجانبية

  • استعلام فقط. لا يحجز أي شيء، ولا يقدّم طلب شراء، ولا يغيّر أي شيء.
  • تعكس النتائج المخزون وقت الطلب، وقد تتغير بين الاستدعاءات.