Method: spaces.messages.create

สร้างข้อความในพื้นที่ใน Google Chat ดูตัวอย่างได้ที่ส่งข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้:

  • การตรวจสอบสิทธิ์แอปที่มีขอบเขตการให้สิทธิ์
    • https://www.googleapis.com/auth/chat.bot
  • การตรวจสอบสิทธิ์ผู้ใช้ ที่มีขอบเขตการให้สิทธิ์รายการใดรายการหนึ่งต่อไปนี้:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://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

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ที่จะสร้างข้อความ

รูปแบบ: spaces/{space}

พารามิเตอร์การค้นหา

พารามิเตอร์
threadKey
(deprecated)

string

ไม่บังคับ เลิกใช้งานแล้ว: ให้ใช้ thread.thread_key แทน รหัสของชุดข้อความ รองรับอักขระสูงสุด 4,000 ตัว หากต้องการเริ่มหรือเพิ่มลงในชุดข้อความ ให้สร้างข้อความและระบุ threadKey หรือ thread.name ดูตัวอย่างการใช้งานได้ที่เริ่มหรือตอบกลับชุดข้อความ
requestId

string

ไม่บังคับ รหัสที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอจะทำให้คำขอเป็น Idempotent ซึ่งช่วยให้มั่นใจได้ว่าคำขอที่เหมือนกันหลายรายการที่มีรหัสคำขอเดียวกันจะส่งผลให้มีการสร้างข้อความเพียงรายการเดียว คำขอที่ตามมาซึ่งมีรหัสคำขอเดียวกันจะแสดงผลข้อความที่มีอยู่และจะไม่อัปเดตข้อความ แม้ว่ารายละเอียดที่ขอจะแตกต่างจากสถานะปัจจุบันก็ตาม

วิธีใช้ช่องนี้อย่างมีประสิทธิภาพ

  • ตรวจสอบว่าคำขอที่ตามมาเหมือนกันและใช้ข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์เดียวกันกับคำขอเดิม
  • หากมีการสร้างข้อความด้วยรหัสคำขอที่ระบุไว้แล้ว คำขอจะแสดงข้อความนั้น โปรดทราบว่าข้อความที่แสดงอาจมีข้อมูลไม่ครบถ้วน เนื่องจาก API จะแสดงข้อความในคำขอของคุณพร้อมชื่อทรัพยากรที่ระบบกำหนด หากต้องการดึงข้อมูลเมตาล่าสุดของข้อความ ให้เรียก messages.get
  • การใช้รหัสคำขอที่มีอยู่ซ้ำกับผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์รายอื่นจะทำให้เกิดข้อผิดพลาด
messageReplyOption

enum (MessageReplyOption)

ไม่บังคับ ระบุว่าข้อความจะเริ่มชุดข้อความใหม่หรือตอบกลับชุดข้อความที่มีอยู่ รองรับเฉพาะในพื้นที่ทำงานที่มีชื่อ

ระบบจะละเว้นช่องนี้เมื่อตอบสนองต่อการโต้ตอบของผู้ใช้ สำหรับการโต้ตอบภายในชุดข้อความ ระบบจะสร้างการตอบกลับในชุดข้อความเดียวกัน แต่หากไม่เป็นเช่นนั้น ระบบจะสร้างการตอบกลับเป็นชุดข้อความใหม่
messageId

string

ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ ช่วยให้แอปใน Chat รับ อัปเดต หรือลบข้อความได้โดยไม่ต้องจัดเก็บรหัสที่ระบบกำหนดไว้ในชื่อทรัพยากรของข้อความ (แสดงในช่อง name ของข้อความ)

ค่าของช่องนี้ต้องเป็นไปตามข้อกำหนดต่อไปนี้

  • ขึ้นต้นด้วย client- เช่น client-custom-name เป็นรหัสที่กำหนดเองที่ถูกต้อง แต่ custom-name ไม่ถูกต้อง
  • มีอักขระไม่เกิน 63 ตัว และมีเฉพาะตัวอักษรพิมพ์เล็ก ตัวเลข และยัติภังค์
  • ไม่ซ้ำกันภายในพื้นที่ทำงาน แอปใน Chat จะใช้รหัสที่กำหนดเองเดียวกันสำหรับข้อความต่างๆ ไม่ได้

ดูรายละเอียดได้ที่ตั้งชื่อข้อความ
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

ไม่บังคับ ควบคุมลักษณะการทำงานของการแจ้งเตือนเมื่อมีการโพสต์ข้อความ ดูข้อมูลเพิ่มเติมได้ที่บังคับการแจ้งเตือนหรือส่งข้อความแบบเงียบ

เนื้อความของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Message

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Message ที่สร้างขึ้นใหม่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

MessageReplyOption

ระบุวิธีตอบกลับข้อความ โดยอาจมีการเพิ่มสถานะอื่นๆ ในอนาคต

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED ค่าเริ่มต้น เริ่มชุดข้อความใหม่ การใช้ตัวเลือกนี้จะละเว้น thread ID หรือ threadKey ที่รวมไว้
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD สร้างข้อความเป็นการตอบกลับชุดข้อความที่ระบุโดย thread ID หรือ threadKey หากทำไม่สำเร็จ ข้อความจะเริ่มชุดข้อความใหม่แทน
REPLY_MESSAGE_OR_FAIL สร้างข้อความเป็นการตอบกลับชุดข้อความที่ระบุโดย thread ID หรือ threadKey หากใช้ threadKey ใหม่ ระบบจะสร้างชุดข้อความใหม่ หากสร้างข้อความไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด NOT_FOUND แทน

CreateMessageNotificationOptions

ตัวเลือกสำหรับลักษณะการทำงานของการแจ้งเตือนเมื่อมีการโพสต์ข้อความ

การแสดง JSON 
{
  "notificationType": enum (NotificationType)
}
ช่อง
notificationType

enum (NotificationType)

ประเภทการแจ้งเตือนสำหรับข้อความ

NotificationType

ตัวเลือกประเภทการแจ้งเตือนสำหรับข้อความ

Enum
NOTIFICATION_TYPE_NONE ลักษณะการทำงานเริ่มต้น ลักษณะการทำงานของการแจ้งเตือนจะคล้ายกับกรณีที่ผู้ใช้ส่งข้อความโดยใช้ UI ของ Chat กล่าวคือ ระบบจะไม่ส่งการแจ้งเตือนไปยังผู้ส่งที่เป็นผู้ใช้
NOTIFICATION_TYPE_FORCE_NOTIFY

บังคับให้แจ้งเตือนผู้รับ ซึ่งจะข้ามการตั้งค่าการแจ้งเตือนพื้นที่ทำงานและการตั้งค่าโหมดห้ามรบกวนของ Chat ตัวเลือกนี้จะไม่ข้ามการตั้งค่าโหมดห้ามรบกวนระดับอุปกรณ์

ต้องมีการตรวจสอบสิทธิ์แอป
NOTIFICATION_TYPE_SILENT

ไม่แจ้งเตือนผู้รับและไม่ทำเครื่องหมายข้อความว่ายังไม่ได้อ่าน ลักษณะการทำงานนี้จะคล้ายกับการที่ผู้ใช้ปิดเสียงการสนทนาหรือเปิดใช้โหมดห้ามรบกวนของ Chat

ต้องมีการตรวจสอบสิทธิ์แอป