Method: projects.locations.apps.sessions.generateChatToken

Generiert ein sitzungsbezogenes Token für das Chat-Widget zur Authentifizierung bei Session APIs.

HTTP-Anfrage

POST https://ces.googleapis.com/v1/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Sitzungsname, für den das Chat-Token generiert werden soll. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
Felder
deployment

string

Erforderlich. Die Bereitstellung der App, die für die Sitzung verwendet werden soll. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptchaToken

string

Optional. Das reCAPTCHA-Token, das vom clientseitigen Chat-Widget generiert wird.
liveHandoffEnabled

boolean

Optional. Gibt an, ob die Übergabe an einen Live-Agent für die Sitzung aktiviert ist.

Antworttext

Antwortnachricht für WidgetService.GenerateChatToken.

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

JSON-Darstellung 
{
  "chatToken": string,
  "expireTime": string
}
Felder
chatToken

string

Das sitzungsbezogene Token für das Chat-Widget zur Authentifizierung bei Session APIs.
expireTime

string (Timestamp format)

Der Zeitpunkt, zu dem das Chat-Token abläuft.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Weitere Informationen finden Sie unter Authentication Overview.