Method: projects.locations.apps.sessions.generateChatToken

Membuat token cakupan sesi untuk widget chat agar dapat diautentikasi dengan Session API.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama sesi untuk membuat token chat. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
Kolom
deployment

string

Wajib. Deployment aplikasi yang akan digunakan untuk sesi. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptchaToken

string

Opsional. Token reCAPTCHA yang dihasilkan oleh widget chat sisi klien.
liveHandoffEnabled

boolean

Opsional. Menunjukkan apakah pengalihan langsung diaktifkan untuk sesi.

Isi respons

Pesan respons untuk WidgetService.GenerateChatToken.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "chatToken": string,
  "expireTime": string
}
Kolom
chatToken

string

Token cakupan sesi untuk widget chat guna mengautentikasi dengan Session API.
expireTime

string (Timestamp format)

Waktu saat token chat berakhir masa berlakunya.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.