Method: phones.getCapabilities

Ruft die RBM-bezogenen Funktionen eines Nutzers ab.

Die zurückgegebene Nutzlast gibt an, ob ein Nutzer mit RBM erreicht werden kann und wenn ja, welche RBM-Funktionen der Nutzer unterstützt. Wenn der Nutzer mit RBM nicht erreicht werden kann, gibt die RBM-Plattform 404 NOT_FOUND zurück.

Für einen nicht eingeführten Bot können nur Funktionen für Nutzer angefordert werden, die Tester dieses Bots sind. Wenn ein nicht gestarteter Agent die Funktionen eines Nicht-Testers anfordert, gibt die RBM-Plattform 403 PERMISSION_DENIED zurück.

HTTP-Anfrage

GET https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*}/capabilities

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Dieses Feld wird in „phones/{E.164}/capabilities“ aufgelöst, wobei {E.164} die Telefonnummer des Nutzers im E.164-Format ist. Für einen Nutzer mit der US-amerikanischen Telefonnummer +1-222-333-4444 lautet der resultierende Endpunkt beispielsweise https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

Abfrageparameter

Parameter
requestId

string

Die eindeutige ID der Anfrage, die vom Agent zugewiesen wurde. Dies muss eine UUID sein, wie unter https://tools.ietf.org/html/rfc4122 definiert. Wenn die Anfrage-ID mit einer ID übereinstimmt, die der Agent für eine vorherige Anfrage verwendet hat, ignoriert die RBM-Plattform die neue Anfrage.
agentId

string

Erforderlich. Die eindeutige Kennung des Kundenservicemitarbeiters.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Liste der vom Nutzer unterstützten Funktionen

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "features": [
    enum (Feature)
  ]
}
Felder
features[]

enum (Feature)

Liste der von diesem Gerät unterstützten RBM-Funktionen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.

Funktion

Arten von RBM-Funktionen, die der Nutzer unterstützt.

Enums
FEATURE_UNSPECIFIED Nicht angegeben.
REVOCATION Widerruf Wenn der Nutzer den Widerruf unterstützt, kann der Kundenservicemitarbeiter eine gesendete Nachricht widerrufen, bevor die RBM-Plattform sie zustellt.
RICHCARD_STANDALONE Eigenständige Rich Cards
ACTION_CREATE_CALENDAR_EVENT Vorgeschlagene Aktion zum Erstellen eines Kalendertermins.
ACTION_DIAL Vorgeschlagene Aktion zum Wählen einer Nummer.
ACTION_OPEN_URL Vorgeschlagene Aktion zum Öffnen einer URL im Browser.
ACTION_SHARE_LOCATION Vorgeschlagene Aktion zum Teilen eines Standorts.
ACTION_VIEW_LOCATION Vorgeschlagene Aktion, um sich einen Ort in einer Karten-App anzusehen.
ACTION_OPEN_URL_IN_WEBVIEW Vorgeschlagene Aktion zum Öffnen einer URL in WebView.
ACTION_COMPOSE Vorgeschlagene Aktion zum Schreiben einer Text-/Audio-/Videonachricht.