Erreichbarkeit

Reachability Insight liefert Echtzeitinformationen direkt von Mobilfunkanbietern und kann verwendet werden, um den Verbindungsstatus eines bestimmten Geräts zu überprüfen, einschließlich der Frage, ob es für Daten, SMS oder beides mit dem Netz verbunden ist.

Die wichtigsten Vorteile sind:

  • Verbessertes Nutzererlebnis durch Versenden relevanter Mitteilungen: Ermitteln Sie die Erreichbarkeit eines Kunden und senden Sie ihm die entsprechende Kommunikation, per SMS oder Daten.
  • Verwaltung der Kundendatenbank: Bestimmen Sie, welche Kunden kontaktiert werden müssen, um ihre Telefonnummer zu aktualisieren, z. B. wenn ein bestimmter Nutzer in den letzten 60 Tagen keine Daten- oder SMS-Verbindung hatte.
  • Schnelle Ferndiagnose und Überwachung von IoT-Geräten: Erkennen Sie, welche Geräte offline sind, und wenn ja, wann sie zuletzt online waren, und erfahren Sie aus der Ferne, welche Geräte gewartet werden müssen.

Voraussetzungen

Um Identity Insights nutzen zu können, müssen Sie sicherstellen, dass Ihr Account korrekt konfiguriert ist; siehe die Erste Schritte Leitfaden für weitere Informationen über:

  • Erstellen Sie Ihren Account,
  • Erstellen einer Vonage-Anwendung zur Verwendung mit der Identity Insights API,
  • Die verschiedenen verfügbaren Umgebungen und wie Sie Ihren Account für deren Nutzung konfigurieren,
  • Und wie Sie die Dashboard-Einstiegs-UI verwenden, um die API zu nutzen, ohne Code zu schreiben.

In dieser Anleitung wird erklärt, wie man Reachability Insight programmatisch mit cURL verwendet.

Die Identity Insights API ist über mehrere regionale Endpunkte verfügbar. Die Beispiele in diesem Leitfaden verwenden den EU-Endpunkt, aber Sie finden die vollständige Liste unter Technische Details.

Einen API-Aufruf tätigen

Die Authentifizierung für die Identity Insights API erfolgt über JWTs, ein kompaktes und in sich geschlossenes JSON-Token. Um ein JWT zu generieren, können Sie unser Online-Generatoroder verwenden Sie alternativ die Vonage CLI. Sie benötigen Ihre Anwendungs-ID und Ihren privaten Schlüssel, um das JWT zu erzeugen. Sobald Sie Ihr JWT haben, können Sie eine Anfrage an die API senden.

Dieses Beispiel zeigt eine cURL-Anfrage für den Einblick in die Erreichbarkeit, um zu prüfen, ob und wie ein bestimmtes Gerät mit dem Mobilfunknetz verbunden ist:

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

Die API gibt dann Roaming-Informationen für dieses Gerät zurück - wenn es Roaming betreibt und das Land, in dem es Roaming betreibt, identifiziert werden kann, wird dieses Land mit der Option country_codes Feld:

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

Sie sehen die folgenden Felder im Fenster roaming Array:

Feld Beschreibung
latest_status_at Letzter Zeitpunkt der Aktualisierung des zugehörigen Gerätekonnektivitätsstatus.
is_reachable Zeigt die allgemeine Erreichbarkeit des Geräts an - wird true wenn das Gerät mit dem Netzwerk verbunden ist.
connectivity Zeigt an, ob das Gerät mit dem Netzwerk verbunden ist für DATA oder SMS Verwendung. Wird nur zurückgegeben, wenn is_reachable ist true.
status Gibt den Status der Informationen an, die für die angegebene Telefonnummer zurückgegeben werden.
code Code, der den Status der Anfrage angibt. Muss einer der folgenden sein:

NO_COVERAGE: Das Land oder das Mobilfunknetz wird von den verfügbaren Anbietern nicht unterstützt.
INVALID_PURPOSE: Der verwendete Zweck ist für diese Einsicht nicht gültig oder zulässig.
UNAUTHORIZED: Die Anfrage konnte für die Kombination aus Antrag, Lieferant und Telefonnummer nicht autorisiert werden.
INTERNAL_ERROR: Bei der Bearbeitung der Anfrage ist ein interner Fehler aufgetreten.
SUPPLIER_ERROR: Der Anbieter hat bei der Bearbeitung der Anfrage einen Fehler gemeldet.
NOT_FOUND: Die Rufnummer konnte für diese Einsicht nicht gefunden werden.
INVALID_NUMBER_FORMAT: Das Format der Telefonnummern ist für die Zuweisung durch die Netzbetreiber an die Benutzer nicht gültig.
PARTIAL_SUCCESS: Einige Antwortattribute wurden weggelassen, weil sie nicht anwendbar oder nicht verfügbar waren.
OK: Alle Insight-Attribute sind verfügbar und in der Antwort enthalten.
message Ausführlichere Statusbeschreibung.

Weitere Lektüre