- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- ลองใช้งาน
สร้างข้อความในพื้นที่ใน Chat ของ Google Chat ดูตัวอย่างได้ที่ส่งข้อความ
รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้:
- การตรวจสอบสิทธิ์แ/1} แอปที่มีขอบเขตการให้สิทธิ์ต่อไปนี้:
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 ไบต์
สำหรับคำขอ เว็บฮุค การตอบกลับจะไม่มีข้อความฉบับเต็ม การตอบกลับจะป้อนข้อมูลเฉพาะในช่อง name และ thread.name นอกเหนือจากข้อมูลที่อยู่ในคำขอ
คำขอ HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
URL ใช้ไวยากรณ์การแปลงรหัส gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ | |
|---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างข้อความ รูปแบบ: |
พารามิเตอร์การค้นหา
| พารามิเตอร์ | |
|---|---|
threadKey |
ไม่บังคับ เลิกใช้งานแล้ว: ใช้ |
requestId |
ไม่บังคับ รหัสคำขอที่ไม่ซ้ำกันสำหรับข้อความนี้ การระบุรหัสคำขอที่มีอยู่จะแสดงข้อความที่สร้างด้วยรหัสดังกล่าวแทนที่จะสร้างข้อความใหม่ |
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_FORCE_NOTIFY |
บังคับให้แจ้งเตือนผู้รับ การดำเนินการนี้จะข้ามการตั้งค่าการแจ้งเตือนพื้นที่ทำงานและการตั้งค่าโหมดห้ามรบกวนของ Chat ของผู้ใช้ ตัวเลือกนี้จะไม่ข้ามการตั้งค่าโหมดห้ามรบกวนระดับอุปกรณ์ ต้องมีการตรวจสอบสิทธิ์แอป |
NOTIFICATION_TYPE_SILENT |
ปิดเสียงการแจ้งเตือนเสมือนว่าผู้รับเปิดใช้โหมดห้ามรบกวนของ Chat หรือปิดเสียงพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์แอป |