Menambahkan pesan atau polling ke live chat.
Kasus penggunaan umum
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca selengkapnya tentang autentikasi dan otorisasi, lihat Menerapkan autentikasi OAuth 2.0.
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 | ||
part |
string Parameter part memiliki dua tujuan. Ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang akan disertakan dalam respons API. Tetapkan nilai parameter ke snippet . |
Isi permintaan
Berikan resource liveChatMessage dalam isi permintaan. Untuk resource tersebut, Anda harus menentukan nilai untuk properti ini
snippet.liveChatId
snippet.type
- pilih salah satu opsi berikut:textMessageEvent
ataupollEvent
- Jika jenisnya
textMessageEvent
, sertakansnippet.textMessageDetails.messageText
- Jika jenisnya
pollEvent
, sertakansnippet.pollDetails
dengan nilai berikut:snippet.pollDetails.metadata.options.questionText
- Daftar
snippet.pollDetails.metadata.options.optionText
. Anda harus mencantumkan minimal dua item dan maksimal lima item. Item ditampilkan secara berurutan sesuai urutan yang tercantum.
Respons
Jika berhasil, metode ini akan menampilkan resource liveChatMessage dalam isi respons.
Error
Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Untuk mengetahui detail selengkapnya, lihat YouTube Live Streaming API - Error.
Jenis error | Detail error | Deskripsi |
---|---|---|
forbidden (403) |
forbidden |
Anda tidak memiliki izin yang diperlukan untuk membuat pesan yang ditentukan. |
forbidden (403) |
liveChatDisabled |
Live chat yang ditentukan telah dinonaktifkan oleh pemilik, yang berarti pesan tidak dapat ditambahkan ke chat. |
forbidden (403) |
liveChatEnded |
Live chat yang ditentukan tidak lagi aktif. |
invalidValue (400) |
messageTextInvalid |
Teks pesan (snippet.textMessageDetails.messageText ) tidak valid. |
notFound (404) |
liveChatNotFound |
Live chat yang diidentifikasi dalam permintaan API tidak ada. Error ini terjadi jika chat telah dihapus oleh pemiliknya. |
required (400) |
liveChatIdRequired |
Resource liveChatMessage harus menyertakan dan menentukan nilai untuk properti snippet.liveChatId . |
required (400) |
messageTextRequired |
Resource liveChatMessage harus menyertakan dan menentukan nilai untuk properti snippet.textMessageDetails.messageText . |
required (400) |
typeRequired |
Resource liveChatMessage harus menyertakan dan menentukan nilai untuk properti snippet.type . Tetapkan nilai parameter ke text |
required (400) |
preconditionCheckFailed |
Sudah ada polling aktif yang disematkan. |
rateLimitExceeded |
rateLimitExceeded |
Pengguna telah memposting terlalu banyak pesan chat dalam jangka waktu tertentu. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan serta respons API.