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

مناطق بادئة محددة

GET/api/v2/telecom/area-codes/{code}

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

فهم الإجابة

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

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

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

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

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

dataobject

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

data.codestring

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

data.international_prefixstring

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

data.descriptionobject

وصف البادئة باللغات المتاحة.

data.description.arnull

القيمة بالعربية؛ null عند غياب الترجمة.

القيم المقبولة: null

data.description.frstring

القيمة بالفرنسية؛ null عند غياب الترجمة.

data.description.enstring

القيمة بالإنجليزية؛ null عند غياب الترجمة.

data.areasobject

المناطق المخدومة حسب المصدر، موزّعة حسب اللغة؛ وليست حدوداً إدارية دقيقة.

data.areas.arnull

القيمة بالعربية؛ null عند غياب الترجمة.

القيم المقبولة: null

data.areas.frstring[]

القيمة بالفرنسية؛ null عند غياب الترجمة.

data.areas.enstring[]

القيمة بالإنجليزية؛ null عند غياب الترجمة.

data.hcp_codenull

null: لا يتوفر ربط إداري مؤكد مع HCP لهذه المناطق الهاتفية.

القيم المقبولة: null

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

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "code",
        "international_prefix",
        "description",
        "areas",
        "hcp_code"
      ],
      "properties": {
        "code": {
          "type": "string",
          "minLength": 2,
          "maxLength": 6,
          "pattern": "^0[5-8][0-9]{0,4}$"
        },
        "international_prefix": {
          "type": "string"
        },
        "description": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ar",
            "fr",
            "en"
          ],
          "properties": {
            "ar": {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            },
            "fr": {
              "type": "string"
            },
            "en": {
              "type": "string"
            }
          }
        },
        "areas": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ar",
            "fr",
            "en"
          ],
          "properties": {
            "ar": {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            },
            "fr": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "en": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "hcp_code": {
          "type": "string",
          "nullable": true,
          "enum": [
            null
          ]
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "area-codes"
          ]
        },
        "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
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

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

metaobject

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

meta.datasetstring

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

القيم المقبولة: "area-codes"

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

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

الأخطاء

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

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

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

مناطق بادئة محددة

المعاملات

طلبك