CapabilityCallbackResponse

Die RBM-Fähigkeit eines Nutzers. Diese Antwort ist das Ergebnis einer Capability.requestCapabilityCallback-Anfrage vom Agent.

Die CapabilityCallbackResponse wird im Feld „data“ des Objekts „message“ angezeigt, das der Agent von seinem Google Cloud Pub/Sub-Abo erhält. Das Feld „data“ ist ein base64-codierter String, den der Agent decodieren muss, um der CapabilityCallbackResponse-Struktur zu entsprechen.

JSON-Darstellung 
{
  "requestId": string,
  "phoneNumber": string,
  "rbmEnabled": boolean,
  "features": [
    enum (Feature)
  ],
  "status": {
    object (Status)
  }
}
Felder
requestId

string

Die UUID, die der Agent der Anfrage „Capability.requestCapabilityCallback“ zugewiesen hat.
phoneNumber

string

Telefonnummer des Nutzers im E.164-Format.
rbmEnabled

boolean

Ob der Nutzer an RBM-Unterhaltungen mit Kundenservicemitarbeitern teilnehmen kann.
features[]

enum (Feature)

Liste aller RBM-Funktionen, die für diese Telefonnummer unterstützt werden
status

object (Status)

Status der Antwort. Falls die Funktionsprüfung fehlschlägt, werden auch Fehlermeldungen hinzugefügt.

Status

Mit dem Typ Status wird ein logisches Fehlermodell definiert, das für verschiedene Programmierumgebungen wie REST APIs und RPC APIs geeignet ist. Dieses Modell wird von gRPC verwendet. Jede Status-Meldung enthält die folgenden drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.

Weitere Informationen zu diesem Fehlermodell und zur Arbeit damit finden Sie in der API-Designanleitung.

JSON-Darstellung 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.
message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede Fehlermeldung an den Nutzer sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.
details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.