Formato

El Format Insight es una herramienta de validación fundamental que verifica si un número de teléfono está correctamente estructurado y es potencialmente asignable a un abonado. Garantiza que el número cumple las normas internacionales de marcación, identifica el país asociado y determina la zona horaria correspondiente. Esta información no confirma si el número está actualmente activo o en uso, pero es un primer paso crucial para evaluar la validez técnica de cualquier número de teléfono global.

Al analizar la sintaxis del número y la estructura del prefijo, Format Insight ayuda a identificar si el número pertenece a un rango de numeración válido en un país concreto. También señala los números obviamente no válidos o mal formados, lo que permite a las organizaciones limpiar los datos antes de utilizarlos con fines operativos o de marketing.

La integración de la información sobre formatos en sus aplicaciones puede ayudarle en diversas situaciones, por ejemplo:

  • Calidad y limpieza de datos: Format Insight es ideal para limpiar bases de datos históricas de clientes. Filtra los números con formato incorrecto o claramente inválidos, lo que ayuda a mantener altos estándares de higiene de datos y mejora la contactabilidad general.
  • Validación en tiempo real en la entrada: Las empresas pueden integrar esta información en formularios web o sistemas CRM para validar los números de teléfono a medida que se introducen, lo que reduce el riesgo de errores de introducción y garantiza que sólo se almacenen los números con el formato adecuado.
  • Segmentación y localización: Conocer el país y la zona horaria asociados a un número permite a las empresas adaptar sus comunicaciones, programar la difusión en las franjas horarias adecuadas y cumplir la normativa local.
  • Optimización de costes: Evite interactuar con números no válidos que, de otro modo, darían lugar a intentos de entrega fallidos, esfuerzos operativos desperdiciados y costes innecesarios en SMS, voz o flujos de trabajo de prevención del fraude.

En resumen, Format Insight proporciona un método de baja latencia y alta fiabilidad para validar números de teléfono globales a escala. Es un elemento clave en cualquier proceso de inteligencia de números de teléfono, ya que sienta las bases para comprobaciones más avanzadas, como información sobre operadores y funciones de red para el análisis del riesgo de fraude.

Requisitos previos

Para utilizar Identity Insights, debe asegurarse de que su Account está configurado correctamente; consulte la sección Primeros pasos para obtener más información:

  • Crear una Account,
  • Creación de una aplicación de Vonage para su uso con la API Identity Insights,
  • Los diferentes entornos disponibles y cómo configurar su Account para utilizarlos,
  • Y cómo utilizar la interfaz de usuario de inicio del panel de control para utilizar la API sin escribir ningún código.

En esta guía se explica cómo utilizar Format Insight mediante programación con cURL.

La API Identity Insights está disponible a través de varios puntos finales regionales. Los ejemplos de esta guía utilizan el punto final de la UE, pero puede consultar la lista completa en Detalles técnicos.

Realizar una llamada a la API

La autenticación para la API Identity Insights se realiza mediante JWT, un token JSON compacto y autocontenido. Para generar un JWT, puede utilizar nuestra herramienta generador en líneao, alternativamente, utilice el botón CLI de Vonage. Necesitará su ID de aplicación y su clave privada para generar el JWT. Una vez que tenga su JWT, puede enviar una solicitud a la API.

Este ejemplo muestra una solicitud cURL para que Format insight devuelva información útil basada en el número de teléfono proporcionado:

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": {}
        }
    }'

A continuación, la API valida que el formato del número de teléfono se ajuste a los prefijos, la longitud y los patrones admitidos en cada país, y devuelve información adicional como el prefijo del país, las zonas horarias, la ubicación offline asignada al número y los formatos local e internacional del número:

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

Verá los siguientes campos en format matriz:

Campo Descripción
country_code Código de país de dos caracteres para phone_number. Esto es en ISO 3166-1 alfa-2 formato.
country_name El nombre completo del país en el que phone_number está registrado.
country_prefix El prefijo numérico del país en el que el phone_number está registrado.
offline_location La ubicación en la que se asignó originalmente el número, según su prefijo. No representa la ubicación en tiempo real del dispositivo. El valor indica el país de origen o, cuando está disponible, la zona geográfica específica asociada al número. Sólo los números de teléfono fijo y móvil son elegibles para los datos de localización offline.
time_zones Lista de husos horarios correspondientes al format.offline_location o una lista de un solo elemento con la zona horaria "desconocida" por defecto si no se ha encontrado ninguna otra zona horaria o si el número no es válido. Los valores de las zonas horarias siguen el base de datos tz identificadores.
number_international En phone_number de su solicitud, con formato internacional E.164 formato.
number_national En phone_number de su solicitud, formateado según la convención local del país al que pertenece.
is_format_valid La validación del formato de los números de teléfono consiste en verificar la longitud y los detalles del prefijo a varios niveles para garantizar la exactitud y el cumplimiento de las normas mundiales de numeración. Un formato válido significa que el número puede ser asignado legítimamente por los operadores a los usuarios. Sin embargo, no garantiza que el número esté actualmente asignado a un operador o que sea accesible.
status Indica el estado de la información devuelta para el número de teléfono especificado.
code Código que indica el estado de la solicitud. Debe ser uno de los siguientes:

NO_COVERAGE: El país o la red móvil no son compatibles con los proveedores disponibles.
INVALID_PURPOSE: El propósito utilizado no es válido o no está permitido para este Insight.
UNAUTHORIZED: No se ha podido autorizar la solicitud para la combinación de solicitud, proveedor y número de teléfono.
INTERNAL_ERROR: Se ha producido un error interno al procesar la solicitud.
SUPPLIER_ERROR: El proveedor ha devuelto un error al procesar la solicitud.
NOT_FOUND: No se ha podido encontrar el número de teléfono para este Insight.
INVALID_NUMBER_FORMAT: El formato de número de teléfono no es válido para que las operadoras lo asignen a los usuarios.
OK: La entrada se ha procesado correctamente.
message Descripción más detallada del estado.

Lecturas complementarias