Method: projects.locations.apps.sessions.generateChatToken

为聊天微件生成会话范围的令牌，以便通过会话 API 进行身份验证。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要为其生成聊天令牌的会话名称。格式：projects/{project}/locations/{location}/apps/{app}/sessions/{session}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
字段
deployment

string

必需。会话要使用的应用部署。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptchaToken

string

可选。由客户端聊天 widget 生成的 reCAPTCHA 令牌。
liveHandoffEnabled

boolean

可选。指示会话是否已启用实时移交。

响应正文

WidgetService.GenerateChatToken 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "chatToken": string,
  "expireTime": string
}
字段
chatToken

string

聊天微件的会话范围令牌，用于通过会话 API 进行身份验证。
expireTime

string (Timestamp format)

聊天令牌的过期时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。