الاتصالات/API v2

البادئات والمشغّلون

GET/api/v2/telecom/numbering-ranges

معلومة مهمة. التحقق من الصيغة وبادئات Google محلياً. لا تكشف هوية المشترك أو نشاط الخط أو المشغّل الحالي أو الموقع الفعلي.

المعاملات

prefixstringاختياري · الاستعلام

بادئة وطنية مع الصفر في البداية.

2-6 حرفاً

النمط

^0[5-8][0-9]{0,4}$

categorystringاختياري · الاستعلام

صنف المورد.

operatorstringاختياري · الاستعلام

معرّف المشغّل، مثل maroc-telecom.

2-80 حرفاً

النمط

^[a-z]+(?:-[a-z]+)*$

limitintegerاختياري · الاستعلام

عدد النتائج في الصفحة. 100 افتراضياً، و500 كحد أقصى.

الحد الأدنى: 1الحد الأقصى: 500القيمة الافتراضية: 100

offsetintegerاختياري · الاستعلام

عدد النتائج المطابقة المراد تجاوزها. يبدأ من 0.

الحد الأدنى: 0الحد الأقصى: 2147483647القيمة الافتراضية: 0

فهم الإجابة

data: النتائج المطلوبة، في كائن أو قائمة.

meta: مصادر البيانات ورخصتها وتواريخها. تعني null أن القيمة غير معروفة أو غير متاحة.

meta.pagination: القوائم: 100 نتيجة افتراضياً، و500 كحد أقصى. استخدم limit وoffset؛ تكون meta.pagination.next_offset بقيمة null في الصفحة الأخيرة.

مثال توضيحي: مع limit=10 وoffset=0 تتضمن الصفحة الأولى 10 نتائج على الأكثر. إذا كانت next_offset تساوي 10، اطلب التالية بـoffset=10 والمرشحات نفسها. توقف عندما تصبح next_offset بقيمة null.

API v2 هو المسار المرجعي. تبقى مسارات /api/v1 القديمة أسماء بديلة متوافقة مع السلوك المنشور حالياً، بما فيه تقسيم الصفحات؛ لم يُحدد موعد لحذفها.

حقول الإجابة 10

تشير [] إلى كل عنصر في القائمة. تعني null غير معروف أو غير متاح، ولا تعني صفراً. لغة الدليل لا تترجم قيم المصادر.

dataobject[]

النتيجة المطلوبة: كائن واحد أو قائمة.

data[].prefixstring

الأرقام الأولى للرقم بالصيغة الوطنية، بما فيها الصفر.

data[].international_prefixstring

الصيغة الدولية للبادئة، باستبدال الصفر الأول بـ+212.

data[].maskstring

نمط الرقم: كل X تمثل رقماً متبقياً، مثل 06XXXXXXXX.

data[].categorystring

فئة المؤسسة أو بادئة الهاتف؛ استعمل القيم المنشورة.

القيم المقبولة: "carrier" "geographic"

data[].original_operatorobject | null

المشغل المرتبط بالبادئة في المصدر؛ قد يختلف عن المشغل الحالي.

data[].original_operator.codestring

معرّف المشغل داخل كائن المشغل؛ وبادئة وطنية داخل المنطقة الهاتفية.

data[].original_operator.namestring

اسم المورد، وقد يكون موزّعاً حسب اللغة.

data[].area_codestring | null

بادئة المنطقة الجغرافية المرتبطة، أو null.

data[].more_specific_prefixesstring[]

بادئات فرعية أطول تعطي مطابقة أكثر تحديداً.

بنية البيانات

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "prefix",
          "international_prefix",
          "mask",
          "category",
          "original_operator",
          "area_code",
          "more_specific_prefixes"
        ],
        "properties": {
          "prefix": {
            "type": "string",
            "minLength": 2,
            "maxLength": 6,
            "pattern": "^0[5-8][0-9]{0,4}$"
          },
          "international_prefix": {
            "type": "string"
          },
          "mask": {
            "type": "string",
            "pattern": "^0[0-9]+X+$"
          },
          "category": {
            "enum": [
              "carrier",
              "geographic"
            ]
          },
          "original_operator": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "name"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                }
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "area_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "more_specific_prefixes": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 2,
              "maxLength": 6,
              "pattern": "^0[5-8][0-9]{0,4}$"
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "numbering-ranges"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "Apache-2.0"
          ]
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "transformation_version": {
          "type": "string"
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "Apache-2.0"
                ]
              },
              "source_updated_at": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              }
            }
          }
        },
        "pagination": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "limit",
            "offset",
            "count",
            "has_more",
            "next_offset"
          ],
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 500
            },
            "offset": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 500
            },
            "has_more": {
              "type": "boolean"
            },
            "next_offset": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}

المصادر وتقسيم الصفحات 19

metaobject

سياق النتيجة: المصادر والتواريخ والرخصة وتقسيم الصفحات عند الاقتضاء.

meta.datasetstring

اسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.

القيم المقبولة: "numbering-ranges"

meta.totalinteger

عدد النتائج المطابقة للمرشحات قبل تقسيم الصفحات؛ وليس حجم هذه الصفحة.

meta.licensestring

رخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.

القيم المقبولة: "Apache-2.0"

meta.retrieved_atstring

تاريخ جلب المشروع لملف المصدر؛ وليس تاريخ رصد البيانات.

meta.transformation_versionstring

إصدار قواعد تحويل مجموعة البيانات؛ مستقل عن إصدار الواجهة.

meta.sourcesobject[]

المصادر المستخدمة لهذه النتيجة مع الجهات المنتجة والرخص.

meta.sources[].datasetstring

اسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.

meta.sources[].producerstring

الجهة التي تنشر البيانات الأصلية.

meta.sources[].source_urlstring

صفحة نشر المصدر أو التعريف ببياناته.

meta.sources[].resource_urlstring

رابط الملف أو المورد المستخدم فعلياً.

meta.sources[].licensestring

رخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.

القيم المقبولة: "Apache-2.0"

meta.sources[].source_updated_atstring | null

آخر تحديث معلن من المصدر؛ وليس تاريخ جلب الملف.

meta.paginationobject

معلومات لتصفّح نتائج القائمة صفحة بصفحة.

meta.pagination.limitinteger

العدد الأقصى المطلوب في الصفحة: 100 افتراضياً و500 كحد أقصى.

meta.pagination.offsetinteger

عدد النتائج المتجاوزة قبل هذه الصفحة بعد التصفية. تبدأ الصفحة الأولى من 0.

meta.pagination.countinteger

عدد النتائج الموجودة فعلياً في هذه الصفحة.

meta.pagination.has_moreboolean

تكون true إذا بقيت صفحة أخرى من النتائج.

meta.pagination.next_offsetinteger | null

قيمة offset للصفحة التالية؛ null عند النهاية. احتفظ بالمرشحات نفسها.

الأخطاء

400: معامل غير صالح أو مفقود.

تتضمن الأخطاء error.code وerror.message وerror.request_id.

errorobject: تفاصيل الطلب الفاشل؛ تحل محل data وmeta.
error.codestring: رمز ثابت للخطأ، مثل RESOURCE_NOT_FOUND؛ استعمله في منطق التطبيق.
error.messagestring: شرح مقروء للخطأ؛ استعمل code في منطق التطبيق.
error.request_idstring: معرّف هذا الطلب، يفيد عند الإبلاغ عن مشكلة.

البادئات والمشغّلون

المعاملات

طلبك