- Permintaan HTTP
- Parameter lokasi
- Parameter kueri
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- Cobalah!
Membuat pesan di ruang Google Chat. Untuk contoh, lihat Mengirim pesan.
Mendukung jenis autentikasi berikut:
- Autentikasi aplikasi dengan cakupan otorisasi:
https://www.googleapis.com/auth/chat.bot
- Autentikasi pengguna dengan salah satu cakupan otorisasi berikut:
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.import(khusus ruang mode impor)
Chat mengatribusikan pengirim pesan secara berbeda, bergantung pada jenis autentikasi yang Anda gunakan dalam permintaan Anda.
Gambar berikut menunjukkan cara Chat mengatribusikan pesan saat Anda menggunakan autentikasi aplikasi. Chat menampilkan aplikasi Chat sebagai pengirim pesan. Konten pesan dapat berisi teks (text), kartu (cardsV2), dan widget aksesori (accessoryWidgets).
Gambar berikut menunjukkan cara Chat mengatribusikan pesan saat Anda menggunakan autentikasi pengguna. Chat menampilkan pengguna sebagai pengirim pesan dan mengatribusikan aplikasi Chat ke pesan dengan menampilkan namanya. Konten pesan hanya boleh berisi teks (text).
Ukuran pesan maksimum, termasuk konten pesan, adalah 32.000 byte.
Untuk permintaan webhook, respons tidak berisi pesan lengkap. Respons hanya mengisi kolom name dan thread.name selain informasi yang ada dalam permintaan.
Permintaan HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
URL ini menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter | |
|---|---|
parent |
Wajib. Nama resource ruang tempat pesan akan dibuat. Format: |
Parameter kueri
| Parameter | |
|---|---|
threadKey |
Opsional. Tidak digunakan lagi: Gunakan |
requestId |
Opsional. ID unik untuk permintaan ini. UUID acak direkomendasikan. Menentukan ID permintaan membuat permintaan menjadi idempoten, yang memastikan bahwa beberapa permintaan identik dengan ID permintaan yang sama hanya menghasilkan satu pesan yang dibuat. Permintaan berikutnya dengan ID permintaan yang sama akan menampilkan pesan yang ada dan tidak memperbarui pesan, meskipun detail yang diminta berbeda dari status saat ini. Untuk menggunakan kolom ini secara efektif:
|
messageReplyOption |
Opsional. Menentukan apakah pesan memulai rangkaian pesan atau membalas rangkaian pesan. Hanya didukung di ruang bernama. Saat merespons interaksi pengguna, kolom ini diabaikan. Untuk interaksi dalam rangkaian pesan, balasan dibuat dalam rangkaian pesan yang sama. Jika tidak, balasan akan dibuat sebagai rangkaian pesan baru. |
messageId |
Opsional. ID kustom untuk pesan. Memungkinkan aplikasi Chat mendapatkan, memperbarui, atau menghapus pesan tanpa perlu menyimpan ID yang ditetapkan sistem dalam nama resource pesan (ditampilkan di kolom Nilai untuk kolom ini harus memenuhi persyaratan berikut:
Untuk mengetahui detailnya, lihat Memberi nama pesan. |
createMessageNotificationOptions |
Opsional. Mengontrol perilaku notifikasi saat pesan diposting. Untuk mempelajari lebih lanjut, lihat Memaksa notifikasi atau mengirim pesan senyap. |
Isi permintaan
Isi permintaan memuat instance Message.
Isi respons
Jika berhasil, isi respons akan memuat instance Message yang baru dibuat.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.create
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
MessageReplyOption
Menentukan cara membalas pesan. Negara bagian lainnya mungkin akan ditambahkan pada masa mendatang.
| Enum | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Default. Memulai rangkaian pesan baru. Menggunakan opsi ini akan mengabaikan thread ID atau yang disertakan. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Membuat pesan sebagai balasan ke rangkaian pesan yang ditentukan oleh thread ID atau . Jika gagal, pesan akan memulai rangkaian pesan baru. |
REPLY_MESSAGE_OR_FAIL |
Membuat pesan sebagai balasan ke rangkaian pesan yang ditentukan oleh thread ID atau . Jika threadKey baru digunakan, thread baru akan dibuat. Jika pembuatan pesan gagal, error NOT_FOUND akan ditampilkan. |
CreateMessageNotificationOptions
Opsi untuk perilaku notifikasi saat pesan diposting.
| Representasi JSON |
|---|
{
"notificationType": enum ( |
| Kolom | |
|---|---|
notificationType |
Jenis notifikasi untuk pesan. |
NotificationType
Opsi jenis notifikasi untuk pesan.
| Enum | |
|---|---|
NOTIFICATION_TYPE_NONE |
Perilaku default. Perilaku notifikasi serupa dengan saat pengguna manusia mengirim pesan menggunakan UI Chat: tidak ada notifikasi yang dikirim ke pengirim manusia. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
Memaksa penerima untuk menerima notifikasi. Tindakan ini akan mengabaikan setelan notifikasi ruang pengguna dan setelan Jangan Ganggu Chat. Opsi ini tidak melewati setelan Jangan Ganggu tingkat perangkat. Memerlukan autentikasi aplikasi. |
NOTIFICATION_TYPE_SILENT |
Jangan memberi tahu penerima, dan jangan menandai pesan sebagai belum dibaca. Perilaku ini mirip dengan pengguna yang membisukan percakapan atau mengaktifkan Jangan Ganggu Chat. Memerlukan autentikasi aplikasi. |