Format

Le Format Insight est un outil de validation fondamental qui permet de vérifier si un numéro de téléphone est correctement structuré et potentiellement attribuable à un abonné. Il permet de s'assurer que le numéro est conforme aux normes de numérotation internationales, d'identifier le pays associé et de déterminer le fuseau horaire correspondant. Cet aperçu ne confirme pas si le numéro est actuellement actif ou utilisé, mais il s'agit d'une première étape cruciale dans l'évaluation de la validité technique de tout numéro de téléphone mondial.

En analysant la syntaxe du numéro et la structure du préfixe, Format Insight permet d'identifier si le numéro appartient à une plage de numérotation valide dans un pays spécifique. Il signale également les numéros manifestement invalides ou mal formés, ce qui permet aux organisations de nettoyer les données avant de les utiliser à des fins opérationnelles ou marketing.

L'intégration de l'aperçu du format dans vos Applications peut vous aider dans toute une série de scénarios, notamment :

  • Qualité et nettoyage des données : Format Insight est idéal pour nettoyer les bases de données historiques des clients. Il filtre les numéros mal formatés ou clairement invalides, ce qui permet de maintenir des normes élevées en matière d'hygiène des données et d'améliorer la facilité de contact globale.
  • Validation en temps réel à l'entrée : Les entreprises peuvent intégrer ces informations dans les formulaires web ou les systèmes de gestion de la relation client pour valider les numéros de téléphone au fur et à mesure de leur saisie, ce qui réduit le risque d'erreurs de saisie et garantit que seuls les numéros correctement formatés sont stockés.
  • Segmentation et localisation : Connaître le pays et le fuseau horaire associés à un numéro permet aux entreprises d'adapter leurs communications, de programmer la diffusion dans des créneaux horaires appropriés et de se conformer aux réglementations locales.
  • Optimisation des coûts : Évitez d'avoir recours à des numéros non valides qui entraîneraient des tentatives d'envoi infructueuses, des efforts opérationnels gaspillés et des coûts inutiles dans les flux de travail SMS, vocaux ou de prévention de la fraude.

En résumé, Format Insight offre un moyen à faible latence et à haute fiabilité de valider les numéros de téléphone mondiaux à l'échelle. Il s'agit d'un élément clé de tout pipeline de renseignements sur les numéros de téléphone, qui jette les bases de vérifications plus avancées telles que les informations sur les opérateurs et les caractéristiques du réseau pour l'analyse des risques de fraude.

Conditions préalables

Pour utiliser Identity Insights, vous devez vous assurer que votre Account est correctement configuré. Pour commencer pour plus d'informations :

  • Création de votre Account,
  • Création d'une application Vonage à utiliser avec l'API Identity Insights,
  • Les différents environnements disponibles et comment configurer votre Account pour les utiliser,
  • Et comment utiliser l'interface utilisateur du tableau de bord pour utiliser l'API sans écrire de code.

Ce guide explique comment utiliser Format Insight par programme à l'aide de cURL.

L'API Identity Insights est disponible via plusieurs points de terminaison régionaux. Les exemples de ce guide utilisent le point de terminaison de l'UE, mais vous pouvez en trouver la liste complète à l'adresse suivante Détails techniques.

Faire un appel à l'API

L'authentification pour l'API Identity Insights se fait par le biais de JWT, un jeton JSON compact et autonome. Pour générer un JWT, vous pouvez utiliser notre outil générateur en ligneou bien utiliser la fonction CLI Vonage. Vous aurez besoin de votre identifiant d'application et de votre clé privée pour générer le JWT. Une fois que vous avez votre JWT, vous pouvez envoyer une demande à l'API.

Cet exemple montre une requête cURL pour l'aperçu du format afin de renvoyer des informations utiles en fonction du numéro de téléphone fourni :

curl -X POST https://api-eu.vonage.com/identity-insights/v1/requests  \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "14040000000",
    "purpose": "FraudPreventionAndDetection",
    "insights": {
      "format": {}
        }
    }'

L'API valide ensuite que le format du numéro de téléphone s'aligne sur les préfixes, la longueur et les modèles pris en charge dans chaque pays, et renvoie des informations supplémentaires telles que l'indicatif du pays, les fuseaux horaires, la localisation hors ligne attribuée au numéro, ainsi que les formats local et international du numéro :

{
  "request_id": "c2cc7a65-9b10-493f-9c0a-1c86751a91c4",
  "insights": {
    "format": {
        "country_code": "US",
        "country_name": "United States",
        "country_prefix": "1",
        "offline_location": "Georgia",
        "time_zones": [
          "America/New_York"
        ],
        "number_international": "+14040000000",
        "number_national": "(404) 000-0000",
        "is_format_valid": true,
        "status": {
          "code": "OK",
          "message": "Success"
        }
    }
  }
}

Vous verrez les champs suivants dans la fenêtre format objet :

Champ d'application Description
country_code Code pays à deux caractères pour phone_number. Il s'agit de ISO 3166-1 alpha-2 format.
country_name Le nom complet du pays où le phone_number est enregistré.
country_prefix Le préfixe numérique du pays dans lequel le phone_number est enregistré.
offline_location L'emplacement où le numéro a été attribué à l'origine, en fonction de son préfixe. Il ne s'agit pas de la localisation en temps réel de l'appareil. La valeur indique le pays d'origine ou, lorsqu'elle est disponible, la zone géographique spécifique associée au numéro. Seuls les numéros fixes et mobiles sont éligibles pour les données de localisation hors ligne.
time_zones Liste des fuseaux horaires correspondant à la format.offline_location ou une liste à un seul élément avec le fuseau horaire "inconnu" par défaut si aucun autre fuseau horaire n'a été trouvé ou si le nombre n'est pas valide. Les valeurs des fuseaux horaires suivent le modèle Base de données tz identifiants.
number_international Les phone_number à partir de votre demande, formatée en format international E.164 format.
number_national Les phone_number de votre demande, formaté selon la convention locale du pays auquel il appartient.
is_format_valid La validation du format des numéros de téléphone consiste à vérifier la longueur et les détails du préfixe à différents niveaux afin de garantir l'exactitude et la conformité avec les normes mondiales de numérotation. Un format valide signifie que le numéro peut être légitimement attribué par les opérateurs aux utilisateurs. Toutefois, il ne garantit pas que le numéro est actuellement attribué à un opérateur ou qu'il est joignable.
status Indique l'état des informations renvoyées pour le numéro de téléphone spécifié.
code Code indiquant l'état de la demande. Doit être l'un des suivants :

NO_COVERAGE: Le pays ou le réseau mobile n'est pas pris en charge par les fournisseurs disponibles.
INVALID_PURPOSE: L'objectif utilisé n'est pas valide ou autorisé pour cet Insight.
UNAUTHORIZED: La demande n'a pas pu être autorisée pour la combinaison de l'application, du fournisseur et du numéro de téléphone.
INTERNAL_ERROR: Une erreur interne s'est produite lors du traitement de la demande.
SUPPLIER_ERROR: Le fournisseur a renvoyé une erreur lors du traitement de la demande.
NOT_FOUND: Le numéro de téléphone n'a pas pu être trouvé pour ce Numbers.
INVALID_NUMBER_FORMAT: Le format du numéro de téléphone n'est pas valide pour être attribué par les opérateurs aux utilisateurs.
OK: L'insight a été traité avec succès.
message Description plus détaillée de l'état.

Pour en savoir plus