LiveChatMessages: insert

Menambahkan pesan atau polling ke live chat.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 20 unit.

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. Properti 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 liveChatMessage resource dalam isi permintaan. Untuk resource tersebut, Anda harus menentukan nilai untuk properti ini

  • snippet.liveChatId
  • snippet.type - pilih salah satu opsi berikut: textMessageEvent atau pollEvent
  • Jika jenisnya adalah textMessageEvent, sertakan snippet.textMessageDetails.messageText
  • Jika jenisnya adalah pollEvent, sertakan objek snippet.pollDetails yang disusun sebagai berikut:
    • snippet.pollDetails.metadata.questionText (String): Pertanyaan utama untuk polling.
    • snippet.pollDetails.metadata.options (Array): Daftar objek opsi.
    • Persyaratan: Anda harus menyertakan minimal 2 dan maksimal 4 item.
    • Pengurutan: Item ditampilkan secara berurutan sesuai dengan urutan yang tercantum.
    • Setiap objek dalam array harus berisi:
      • optionText (String): Teks yang ditampilkan untuk pilihan polling tertentu.

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 - Errors.

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 live.
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 percakapan telah dihapus oleh pemilik.
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 parameter value ke text
required (400) preconditionCheckFailed Polling aktif yang disematkan sudah ada.
rateLimitExceeded rateLimitExceeded Pengguna telah memposting terlalu banyak pesan chat dalam jangka waktu tertentu.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan API serta respons API.