Method: projects.locations.apps.sessions.generateChatToken

為即時通訊小工具產生工作階段範圍權杖，以便透過 Session 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

選用。用戶端即時通訊小工具產生的 reCAPTCHA 權杖。
liveHandoffEnabled

boolean

選用。指出工作階段是否已啟用即時轉接功能。

回應主體

WidgetService.GenerateChatToken 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "chatToken": string,
  "expireTime": string
}
欄位
chatToken

string

聊天小工具的會期範圍權杖，用於向 Session API 進行驗證。
expireTime

string (Timestamp format)

即時通訊權杖的到期時間。

使用 RFC 3339，產生的輸出內容一律會經過 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。