Method: projects.locations.apps.sessions.generateChatToken

Genera un token con alcance de sesión para que el widget de chat se autentique con las APIs de Session.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es el nombre de la sesión para la que se generará el token de chat. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
Campos
deployment

string

Obligatorio. Es la implementación de la app que se usará para la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

recaptchaToken

string

Es opcional. Es el token de reCAPTCHA generado por el widget de chat del cliente.

liveHandoffEnabled

boolean

Es opcional. Indica si la transferencia en vivo está habilitada para la sesión.

Cuerpo de la respuesta

Mensaje de respuesta para WidgetService.GenerateChatToken.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "chatToken": string,
  "expireTime": string
}
Campos
chatToken

string

Es el token con alcance de sesión del widget de chat para autenticarse con las APIs de Session.

expireTime

string (Timestamp format)

Fecha y hora de vencimiento del token de chat.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.