RCS-Geräte-Fähigkeitsprüfung

Es kann eine Fähigkeitsprüfung durchgeführt werden, um festzustellen, ob das Zielgerät RCS-Nachrichtenfunktionen unterstützt. Derzeit gibt es zwei Möglichkeiten, eine Gerätefähigkeitsüberprüfung durchzuführen:

Hinweis: Einige Geräte können von Haus aus RCS-Nachrichten unterstützen, aber der Nutzer hat die Funktion möglicherweise nicht auf dem Gerät aktiviert. Für die Zwecke dieses Dokuments bezeichnet der Begriff "RCS-erreichbar" ein Gerät, das sowohl RCS-fähig ist als auch für das die Funktion aktiviert wurde.

Überprüfung der individuellen Geräteeigenschaften

Die Prüfung erfolgt über eine GET Anfrage an die folgende URL:

https://api.nexmo.com/v1/channel-manager/rcs/agents/{vonage_id}/google/phones/{phone_number}/capabilities

Es sind zwei Pfadparameter erforderlich:

  • vonage_id. Dies ist die Absender-ID für den RCS-Agenten und wird Ihnen als Teil der Anfrage zur Verfügung gestellt. RCS-Einrichtung und Onboarding-Prozess.
  • phone_number. Die Nummer des Geräts, für das die Fähigkeitsprüfung gilt.

A Authorization Header ist als Teil der Anfrage erforderlich. Der Wert der Kopfzeile sollte ein gültiges JWT (JSON Web Token) in folgendem Format enthalten Bearer ${JWT}. Das JWT kann mit der Anwendungs-ID und dem privaten Schlüssel Ihrer Vonage-Anwendung erstellt werden, mit der die RCS-Sender-ID verknüpft ist. Siehe Authentifizierung für weitere Informationen zur Erstellung von JWTs.

Siehe die Kanalmanager-API-Spezifikation für alle technischen Details dieses Endpunkts.

Hinweis: Die Prüfung der individuellen Gerätefähigkeit kann entweder mit einem Testagenten (für Numbers, die für diesen Agenten zugelassen wurden) oder mit einem Live-Agenten (für Numbers, die mit unterstützten Netzen in dem Land verbunden sind, für das der Agent gestartet wurde) durchgeführt werden.

Beispiel-Anfrage

Nachfolgend ein Beispiel für eine cURL-Anfrage an den Endpunkt zur Überprüfung der Fähigkeiten:

curl --location 'https://api.nexmo.com/v1/channel-manager/rcs/agents/VonageBasic/google/phones/447900000000/capabilities' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ...'

Antworten

200 OK

Wenn das Gerät RCS-erreichbar ist, wird ein 200 OK Es wird eine HTTP-Antwort empfangen. Der Antwortkörper enthält ein Array der vom Gerät unterstützten RCS-Funktionen, zum Beispiel:

{ 
  "features": 
   [ 
     "RICHCARD", 
     "RICHCARD_CAROUSEL", 
     "CREATE_CALENDAR_EVENT", 
     "DIAL_PHONE_NUMBER", 
     "OPEN_URL", 
     "SHARE_LOCATION", 
     "VIEW_LOCATION" 
   ] 
}

400 Schlechte Anfrage

Es gibt verschiedene Umstände, unter denen ein 400 Bad Request Es wird eine HTTP-Antwort empfangen, z. B. dass die Absender-ID des Agenten nicht gültig ist oder dass die überprüfte Telefonnummer ein ungültiges Format hat.

403 Verboten

Wenn Sie einen Testagenten verwenden und die Nummer für diesen Agenten nicht zugelassen ist, oder wenn Sie einen Live-Agenten verwenden und die Nummer nicht mit einem unterstützten Netz in dem Land verbunden ist, in dem der Agent gestartet wurde, wird eine 403 Forbidden Es wird eine HTTP-Antwort empfangen.

404 nicht gefunden

Wenn das Gerät nicht über RCS erreichbar ist, wird eine 404 Not Found Es wird eine HTTP-Antwort empfangen.

Bulk Device Capability Check

Die Prüfung erfolgt über eine POST Anfrage an die folgende URL:

https://api.nexmo.com/v1/channel-manager/rcs/agents/{vonage_id}/google/{operation}

Es sind zwei Pfadparameter erforderlich:

  • vonage_id. Dies ist die Absender-ID für den RCS-Agenten und wird Ihnen als Teil der Anfrage zur Verfügung gestellt. RCS-Einrichtung und Onboarding-Prozess.
  • operation. Der vom RBM-Agenten auszuführende Vorgang. In diesem Fall ist es users:batchGet.

A Authorization Header ist als Teil der Anfrage erforderlich. Der Wert der Kopfzeile sollte ein gültiges JWT (JSON Web Token) in folgendem Format enthalten Bearer ${JWT}. Das JWT kann mit der Anwendungs-ID und dem privaten Schlüssel Ihrer Vonage-Anwendung erstellt werden, mit der die RCS-Sender-ID verknüpft ist. Siehe Authentifizierung für weitere Informationen zur Erstellung von JWTs.

A Content-Type Kopfzeile ist als Teil der Anfrage erforderlich. Der Wert des Headers sollte sein application/json.

Die Anfrage sollte einen JSON-Body enthalten, der eine Eigenschaft hat: users. Dies ist ein Array von Strings, die die Telefonnummern darstellen, die bei der Massenprüfung abgerufen werden sollen.

Im Gegensatz zur individuellen Fähigkeitsprüfung liefert die Massenprüfung keine Liste der unterstützten Funktionen. Um die Anzahl der RBM-erreichbaren Benutzer zu schätzen, führen Sie eine Massenprüfung der Fähigkeiten durch. Massenprüfungen zeigen an, ob eine Telefonnummer erreichbar ist, aber nicht, welche Funktionen sie unterstützt.

  • Jede Massenprüfung muss 500-10.000 eindeutige Telefonnummern enthalten. Für mehr müssen Sie mehrere Prüfungen durchführen.
  • Beachten Sie auch, dass bei Anfragen mit weniger als 500, mehr als 10.000 oder doppelten Numbers ein Fehler ausgegeben wird.
  • Bulk Checks liefern eine Liste von Numbers, die Ihr Agent bei eingeführten Betreibern erreichen kann, sowie Schätzungen für die insgesamt erreichbaren Nutzer über alle Betreiber.

Schätzung der insgesamt erreichbaren Nutzer

Während die Antworten auf Massenprüfungen eine Liste von Telefonnummern enthalten, die auf den von Ihrem Agenten eingeführten Trägern sofort erreichbar sind (reachableUsers), enthalten die Antworten auch zwei Werte, mit deren Hilfe die Gesamtzahl der erreichbaren Nutzer über alle Betreiber hinweg geschätzt werden kann.

Wie es funktioniert:

  1. RBM wählt zufällig ~75% der Numbers aus einer Massenfähigkeitsprüfung (totalRandomSampleUserCount).
  2. RBM gibt auch die Anzahl der RBM-erreichbaren Numbers aus der Stichprobe zurück (reachableRandomSampleUserCount).
  3. Durch die Aufteilung reachableRandomSampleUserCount von totalRandomSampleUserCountkönnen Sie den Prozentsatz der Numbers abschätzen, die Ihr Agent erreichen könnte, wenn er auf allen Trägern eingeführt würde.

Beispiel:

Wenn Sie 5.000 Numbers übermitteln, kann RBM eine Zufallsstichprobe von 3.750 Nummern ziehen. Wenn 3.000 davon erreichbar sind, dann waren 80 % der Nummern in der Stichprobe erreichbar.

Siehe die Kanalmanager-API-Spezifikation für alle technischen Details dieses Endpunkts.

Hinweis: Die Massenprüfung der Gerätefähigkeit kann nur mit einem Live-Agenten durchgeführt werden, und in diesem Fall nur für Numbers, die mit unterstützten Netzen in dem Land verbunden sind, für das der Agent gestartet wurde. Bei einem Versuch mit einem Testagenten wird die Antwort ein leeres Objekt sein, auch wenn die geprüften Numbers RCS-fähig sind.

Beispiel-Anfrage

Nachfolgend finden Sie ein Beispiel für eine cURL-Anfrage an den Endpunkt für die Massenprüfung von Fähigkeiten:

curl -X POST https://api.nexmo.com/v1/channel-manager/rcs/agents/VonageBasic/google/users:batchGet \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..." \
-H "Content-Type: application/json" \
-d '{
  "users": [
    "34613994828",
    "34613994829"
  ]
}'

Antworten

200 OK

{ 
  "reachableUsers": [ 
    "34613994828",
    "34613994829"
    // rest of reachableUsers list
  ],
  "totalRandomSampleUserCount": 632,
  "reachableRandomSampleUserCount": 324
}

400 Schlechte Anfrage

Es gibt verschiedene Umstände, unter denen ein 400 Bad Request Es wird eine HTTP-Antwort empfangen, z. B. dass die Absender-ID des Agenten nicht gültig ist oder dass eine oder mehrere der geprüften Telefonnummern ein ungültiges Format haben.