Method: projects.locations.apps.sessions.generateChatToken

Génère un jeton à portée de session pour le widget de chat afin de s'authentifier auprès des API de session.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la session pour laquelle générer le jeton de chat. Format : projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
Champs
deployment

string

Obligatoire. Déploiement de l'application à utiliser pour la session. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptchaToken

string

Facultatif. Jeton reCAPTCHA généré par le widget de chat côté client.
liveHandoffEnabled

boolean

Facultatif. Indique si le transfert en direct est activé pour la session.

Corps de la réponse

Message de réponse pour WidgetService.GenerateChatToken.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "chatToken": string,
  "expireTime": string
}
Champs
chatToken

string

Jeton à portée de session pour le widget de chat afin de s'authentifier auprès des API de session.
expireTime

string (Timestamp format)

Heure d'expiration du jeton de chat.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.