Method: projects.locations.apps.sessions.generateChatToken

Gera um token no escopo da sessão para o widget de chat autenticar com as APIs Session.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome da sessão para gerar o token de chat. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
Campos
deployment

string

Obrigatório. A implantação do app a ser usado na sessão. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptchaToken

string

Opcional. O token do reCAPTCHA gerado pelo widget de chat do lado do cliente.
liveHandoffEnabled

boolean

Opcional. Indica se a transferência para atendimento em tempo real está ativada para a sessão.

Corpo da resposta

Mensagem de resposta para WidgetService.GenerateChatToken.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "chatToken": string,
  "expireTime": string
}
Campos
chatToken

string

O token no escopo da sessão para o widget de chat se autenticar com as APIs de sessão.
expireTime

string (Timestamp format)

O horário em que o token de chat expira.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.