- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- ลองใช้งาน
สร้างข้อความในพื้นที่ใน Chat ใน Google Chat ดูตัวอย่างได้ที่หัวข้อส่งข้อความ
รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
- การตรวจสอบสิทธิ์แอปที่มีขอบเขตการให้สิทธิ์ดังนี้
https://www.googleapis.com/auth/chat.bot
- การตรวจสอบสิทธิ์ของผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.import(พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
Chat จะระบุแหล่งที่มาของผู้ส่งข้อความแตกต่างกันไปตามประเภทการตรวจสอบสิทธิ์ที่คุณใช้ในคำขอ
รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์แอป Chat จะแสดงแอปใน Chat เป็นผู้ส่งข้อความ เนื้อหาของข้อความอาจประกอบด้วยข้อความ (text) การ์ด (cardsV2) และวิดเจ็ตเสริม (accessoryWidgets)
รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์ผู้ใช้ Chat จะแสดงผู้ใช้เป็นผู้ส่งข้อความและระบุแหล่งที่มาของแอปใน Chat ไปยังข้อความโดยแสดงชื่อของแอป เนื้อหาของข้อความต้องมีเฉพาะข้อความ (text) เท่านั้น
ขนาดข้อความสูงสุดรวมถึงเนื้อหาข้อความคือ 32,000 ไบต์
สำหรับคำขอ Webhook การตอบกลับจะไม่มีข้อความแบบเต็ม การตอบกลับจะป้อนข้อมูลเฉพาะในช่อง name และ thread.name นอกเหนือจากข้อมูลที่อยู่ในคำขอ
คำขอ HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
URL ใช้ไวยากรณ์การแปลงรหัส gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ | |
|---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างข้อความ รูปแบบ: |
พารามิเตอร์การค้นหา
| พารามิเตอร์ | |
|---|---|
threadKey |
ไม่บังคับ เลิกใช้งานแล้ว: โปรดใช้ |
requestId |
ไม่บังคับ รหัสที่ไม่ซ้ำกันสำหรับคำขอนี้ เราขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอจะทำให้คำขอเป็นแบบ Idempotent ซึ่งช่วยให้มั่นใจได้ว่าคำขอที่เหมือนกันหลายรายการซึ่งมีรหัสคำขอเดียวกันจะส่งผลให้มีการสร้างข้อความเพียงข้อความเดียว คำขอต่อๆ มาที่มีรหัสคำขอเดียวกันจะแสดงข้อความที่มีอยู่และไม่อัปเดตข้อความ แม้ว่ารายละเอียดที่ขอจะแตกต่างจากสถานะปัจจุบันก็ตาม วิธีใช้ช่องนี้อย่างมีประสิทธิภาพ
|
messageReplyOption |
ไม่บังคับ ระบุว่าข้อความจะเริ่มชุดข้อความหรือตอบกลับชุดข้อความ รองรับเฉพาะในพื้นที่ทำงานที่มีชื่อเท่านั้น เมื่อตอบสนองต่อการโต้ตอบของผู้ใช้ ระบบจะไม่สนใจช่องนี้ สำหรับการโต้ตอบภายในชุดข้อความ ระบบจะสร้างการตอบกลับในชุดข้อความเดียวกัน ไม่เช่นนั้น ระบบจะสร้างการตอบกลับเป็นชุดข้อความใหม่ |
messageId |
ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ ช่วยให้แอปใน Chat รับ อัปเดต หรือลบข้อความได้โดยไม่ต้องจัดเก็บรหัสที่ระบบกำหนดไว้ในชื่อทรัพยากรของข้อความ (แสดงในช่อง ค่าสำหรับช่องนี้ต้องเป็นไปตามข้อกำหนดต่อไปนี้
โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ |
createMessageNotificationOptions |
ไม่บังคับ ควบคุมลักษณะการทำงานของการแจ้งเตือนเมื่อมีการโพสต์ข้อความ ดูข้อมูลเพิ่มเติมได้ที่บังคับการแจ้งเตือนหรือส่งข้อความแบบปิดเสียง |
เนื้อความของคำขอ
เนื้อความของคำขอมีอินสแตนซ์ของ Message
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Message ที่สร้างขึ้นใหม่
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
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
ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
MessageReplyOption
ระบุวิธีตอบกลับข้อความ ทั้งนี้อาจมีการเพิ่มรัฐอื่นๆ ในอนาคต
| Enum | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
ค่าเริ่มต้น เริ่มชุดข้อความใหม่ การใช้ตัวเลือกนี้จะละเว้น thread ID หรือ ที่รวมอยู่ |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
สร้างข้อความเป็นคำตอบสำหรับชุดข้อความที่ระบุโดย thread ID หรือ หากไม่สำเร็จ ข้อความจะเริ่มชุดข้อความใหม่แทน |
REPLY_MESSAGE_OR_FAIL |
สร้างข้อความเป็นคำตอบสำหรับชุดข้อความที่ระบุโดย thread ID หรือ หากใช้ threadKey ใหม่ ระบบจะสร้างชุดข้อความใหม่ หากสร้างข้อความไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด NOT_FOUND แทน |
CreateMessageNotificationOptions
ตัวเลือกสำหรับลักษณะการทำงานของการแจ้งเตือนเมื่อมีการโพสต์ข้อความ
| การแสดง JSON |
|---|
{
"notificationType": enum ( |
| ช่อง | |
|---|---|
notificationType |
ประเภทการแจ้งเตือนสำหรับข้อความ |
NotificationType
ตัวเลือกประเภทการแจ้งเตือนสำหรับข้อความ
| Enum | |
|---|---|
NOTIFICATION_TYPE_NONE |
ลักษณะการทำงานเริ่มต้น ลักษณะการทำงานของการแจ้งเตือนจะคล้ายกับเมื่อผู้ใช้ที่เป็นมนุษย์ส่งข้อความโดยใช้ UI ของ Chat กล่าวคือ ระบบจะไม่ส่งการแจ้งเตือนไปยังผู้ส่งที่เป็นมนุษย์ |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
ระบบจะส่งการแจ้งเตือน (ข้อความ Push, การแจ้งเตือนทางอีเมล ฯลฯ) ไปยังผู้ใช้ที่สร้างข้อความ (เช่น ผู้ใช้ที่มีการใช้การตรวจสอบสิทธิ์เพื่อสร้างข้อความ) และทำเครื่องหมายข้อความว่ายังไม่อ่าน การดำเนินการนี้จะไม่ลบล้างการตั้งค่าการแจ้งเตือนของผู้ใช้ที่มีอยู่สำหรับพื้นที่ทำงาน ตัวอย่างเช่น หากผู้ใช้เลือกที่จะไม่รับการแจ้งเตือนสำหรับพื้นที่ทำงาน ผู้ใช้จะไม่ได้รับการแจ้งเตือนแม้ว่าจะตั้งค่าตัวเลือกนี้ไว้ก็ตาม |
NOTIFICATION_TYPE_FORCE_NOTIFY |
บังคับแจ้งเตือนผู้รับ ซึ่งจะข้ามการตั้งค่าการแจ้งเตือนพื้นที่ทำงานของผู้ใช้และการตั้งค่าห้ามรบกวนของ Chat ตัวเลือกนี้จะไม่ข้ามการตั้งค่าโหมดห้ามรบกวนระดับอุปกรณ์ ต้องใช้การตรวจสอบสิทธิ์ของแอป |
NOTIFICATION_TYPE_SILENT |
ไม่ต้องแจ้งเตือนผู้รับ และไม่ต้องทำเครื่องหมายข้อความว่ายังไม่อ่าน ซึ่งจะทำงานคล้ายกับเมื่อผู้ใช้ปิดเสียงการสนทนาหรือเปิดใช้โหมดห้ามรบกวนใน Chat ต้องใช้การตรวจสอบสิทธิ์ของแอป |