Télécom/API v2

Zones d’un préfixe

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

À savoir. Validation de format et préfixes Google hors ligne. Ni identité, ni ligne active, ni opérateur actuel, ni position physique.

Comprendre la réponse

data: Les résultats demandés, sous forme d’objet ou de liste.

meta: Sources, licence et dates du jeu de données. null signifie une valeur inconnue ou indisponible.

API v2 est le chemin de référence. Les anciens chemins /api/v1 restent des alias de compatibilité du comportement actuellement publié, pagination comprise ; aucune date de suppression n’est fixée.

Champs renvoyés 12

[] désigne chaque élément d’une liste. null signifie inconnu ou indisponible, jamais zéro. La langue du guide ne traduit pas les valeurs des sources.

dataobject

Résultat demandé : objet unique ou liste.

data.codestring

Identifiant de l’opérateur dans un objet opérateur ; préfixe national dans une zone téléphonique.

data.international_prefixstring

Forme internationale du préfixe, avec +212 à la place du zéro initial.

data.descriptionobject

Description du préfixe dans les langues disponibles.

data.description.arnull

Valeur en arabe ; null si aucune traduction n’est fournie.

Valeurs acceptées: null

data.description.frstring

Valeur en français ; null si aucune traduction n’est fournie.

data.description.enstring

Valeur en anglais ; null si aucune traduction n’est fournie.

data.areasobject

Zones desservies selon la source, classées par langue ; pas des frontières administratives exactes.

data.areas.arnull

Valeur en arabe ; null si aucune traduction n’est fournie.

Valeurs acceptées: null

data.areas.frstring[]

Valeur en français ; null si aucune traduction n’est fournie.

data.areas.enstring[]

Valeur en anglais ; null si aucune traduction n’est fournie.

data.hcp_codenull

null : aucun rattachement HCP vérifié n’est fourni pour ces zones téléphoniques.

Valeurs acceptées: null

Structure des données

{
  "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
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Sources et pagination 13

metaobject

Contexte du résultat : sources, dates, licence et pagination si applicable.

meta.datasetstring

Nom du jeu de données auquel appartient le résultat ou la source.

Valeurs acceptées: "area-codes"

meta.totalinteger

Nombre de résultats correspondant aux filtres, avant pagination ; pas la taille de cette page.

meta.licensestring

Licence de réutilisation. mixed signifie des licences différentes : consultez chaque source.

Valeurs acceptées: "Apache-2.0"

meta.retrieved_atstring

Date de récupération du fichier source par le projet ; pas la date des observations.

meta.transformation_versionstring

Version des règles de conversion du jeu de données ; distincte de l’API.

meta.sourcesobject[]

Sources utilisées pour ce résultat, avec leurs producteurs et licences.

meta.sources[].datasetstring

Nom du jeu de données auquel appartient le résultat ou la source.

meta.sources[].producerstring

Organisme qui publie la donnée originale.

meta.sources[].source_urlstring

Page de présentation ou de publication de la source.

meta.sources[].resource_urlstring

Lien vers le fichier ou la ressource utilisée.

meta.sources[].licensestring

Licence de réutilisation. mixed signifie des licences différentes : consultez chaque source.

Valeurs acceptées: "Apache-2.0"

meta.sources[].source_updated_atstring | null

Dernière mise à jour annoncée par la source ; pas la date de récupération.

Erreurs

400: Paramètre invalide ou manquant.
404: Ressource introuvable.

Les erreurs renvoient error.code, error.message et error.request_id.

errorobject: Détails d’une requête échouée ; remplace data et meta.
error.codestring: Code stable de l’erreur, par exemple RESOURCE_NOT_FOUND ; à utiliser dans votre logique.
error.messagestring: Explication lisible de l’erreur ; utilisez code pour la logique de votre application.
error.request_idstring: Identifiant du traitement de cette requête, utile pour retrouver un problème.

Zones d’un préfixe

Paramètres

Votre requête