Accesibilidad [Vista previa para desarrolladores]

Reachability Insight, que proporciona información en tiempo real directamente de las operadoras de telefonía móvil, puede utilizarse para comprobar el estado de conectividad de un dispositivo determinado, incluido si está conectado a la red para datos, SMS o ambos.

Entre las principales ventajas se incluyen:

  • Mejora de la experiencia del usuario mediante el envío de comunicaciones pertinentes: Determine la accesibilidad de un cliente y envíele la comunicación pertinente, por SMS o datos.
  • Gestión de bases de datos de registros de clientes: Determine con qué clientes hay que ponerse en contacto para actualizar su número de teléfono, por ejemplo si un usuario determinado no ha tenido conectividad de datos o SMS en los últimos 60 días.
  • Diagnóstico y supervisión rápidos a distancia de dispositivos IoT: Detectar qué dispositivos están desconectados y, en tal caso, cuándo se conectaron por última vez, y obtener información de forma remota sobre qué dispositivos necesitan mantenimiento.

Nota: El uso de esta información en entorno de producción requiere la autorización de los operadores de telefonía móvil, que se gestiona a través del «Registro de redes». Para saber cómo solicitar el acceso, sigue esta guía.

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 tu Account,
  • Creación de una aplicación de Vonage para su uso con la API Identity Insights,
  • Los distintos entornos disponibles y cómo configurar tu Account para utilizarlos,
  • Y cómo utilizar la interfaz de usuario «Primeros pasos» del panel de control para utilizar la API sin tener que escribir código.

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

La API de Identity Insights está disponible a través de varios puntos de conexión regionales. Los ejemplos de esta guía utilizan el punto de conexión de la UE, pero puedes 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ínea, o bien utiliza el 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 petición cURL a Reachability insight para comprobar si, y cómo, un dispositivo dado está conectado a la red móvil:

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

A continuación, la API devolverá información sobre la accesibilidad de ese dispositivo, incluida una confirmación de la accesibilidad actual y los tipos de tráfico disponibles (actualmente se admiten SMS y datos):

{
  "request_id": "c2cc7a65-9b10-493f-9c0a-1c86751a91c4",
  "insights": {
    "reachability": {
        "latest_status_at":"2024-02-20T10:41:38.657Z",
        "is_reachable": true,
        "connectivity": ["DATA", "SMS"], 
        "status": {
            "code": "OK",
            "message": "Success"
        }
    }
  }
}

Aquí, el status indica el estado de la información devuelta para el número de teléfono especificado:

Campo Descripción
status.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 correspondiente a este Insight.
UNSUPPORTED_NETWORK_TYPE: El tipo de red no es compatible con 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.
status.message Descripción más detallada del estado.

Si status.code en la respuesta se indica que OK, también es posible que aparezcan los campos descritos en la tabla siguiente. Si un campo aparece marcado como «Sí» en la columna «Obligatorio», siempre se mostrará cuando el estado sea «OK». Si un campo aparece marcado como «No», puede que se muestre o puede que no.

Campo Descripción Obligatorio
latest_status_at La última vez que se actualizó el estado de conectividad del dispositivo asociado. Sí
is_reachable Indica la accesibilidad general del dispositivo; será true si el dispositivo está conectado a la red. Sí
connectivity Indica si el dispositivo está conectado a la red para DATA o SMS uso. Solo se devolverá si is_reachable es true. Sí

Lecturas complementarias