Mentransisikan status pesan live chat YouTube dan memulai proses apa pun yang terkait dengan status baru. Misalnya, saat Anda mentransisikan status polling live ke closed, YouTube akan mengakhiri polling pesan tersebut. Sebelum memanggil metode ini, Anda harus mengonfirmasi bahwa nilai properti status untuk pesan polling live adalah active.
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca lebih lanjut tentang autentikasi dan otorisasi).
| Cakupan |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parameter
Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.
| Parameter | ||
|---|---|---|
| Parameter yang diperlukan | ||
id |
stringParameter id menentukan ID unik pesan yang bertransisi ke status lain. |
|
status |
enumParameter status mengidentifikasi status perubahan pesan. Untuk mentransisikan pesan ke status closed, status harus active untuk polling yang terikat dengan pesan.
Anda hanya dapat beralih ke closed, yang berarti polling akan ditutup.
|
|
| Parameter opsional | ||
part |
stringParameter part menentukan bagian resource liveChatMessage yang akan disertakan oleh respons API. Nilai yang didukung adalah id, snippet, dan authorDetails.
Setel nilai parameter ke snippet untuk mendapatkan hasil polling akhir dalam isi respons.
|
|
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Respons
Jika berhasil, metode ini akan menampilkan resource liveChatMessages dalam isi respons.
Error
Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.
| Jenis error | Detail error | Deskripsi |
|---|---|---|
forbidden (403) |
forbidden |
Anda tidak memiliki izin yang diperlukan untuk mentransisikan status pesan yang ditentukan. |
required (400) |
idRequired |
Parameter id yang diperlukan harus mengidentifikasi pesan yang statusnya ingin Anda transisikan. |
required (400) |
statusRequired |
Permintaan API harus menentukan nilai untuk parameter status. |
notFound (404) |
liveChatMessagesNotFound |
Pesan yang ditentukan oleh parameter id tidak ada. |
forbidden (403) |
modificationNotAllowed |
Status resource liveChatMessage yang ditentukan tidak dapat ditransisikan. Parameter id mungkin mengidentifikasi pesan yang statusnya tidak dapat ditransisikan. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini serta melihat permintaan dan respons API.