Method: phones.getCapabilities

Ermitteln Sie die RBM-bezogenen Funktionen eines Nutzers.

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.

Ein nicht gestarteter Agent kann nur Funktionen für Nutzer anfordern, die diesen Agent testen. 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-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. Dabei muss es sich um eine UUID gemäß https://tools.ietf.org/html/rfc4122 handeln. 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 Agents.

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 RBM-Funktionen, die dieses Gerät unterstützt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

Funktion

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

Enums
FEATURE_UNSPECIFIED Nicht angegeben.
REVOCATION Widerruf Wenn der Nutzer das Widerrufen unterstützt, kann der Agent eine gesendete Nachricht widerrufen, bevor die RBM-Plattform sie zustellt.
RICHCARD_STANDALONE Eigenständige Rich Cards
ACTION_CREATE_CALENDAR_EVENT Die vorgeschlagene Aktion zum Erstellen eines Kalendertermins.
ACTION_DIAL Vorgeschlagene Aktion zum Wählen einer Nummer.
ACTION_OPEN_URL Die vorgeschlagene Aktion zum Öffnen einer URL.
ACTION_SHARE_LOCATION Es wurde eine Aktion zum Teilen eines Standorts vorgeschlagen.
ACTION_VIEW_LOCATION Vorgeschlagene Aktion zum Ansehen eines Standorts in einer Karten-App.