Google Chat API

Google Chat API ช่วยให้คุณสร้างแอปใน Chat เพื่อผสานรวมบริการของคุณกับ Google Chat และจัดการทรัพยากรของ Chat เช่น พื้นที่ทำงาน สมาชิก และข้อความ

บริการ: chat.googleapis.com

หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์ที่ Google จัดหาให้ หากแอปพลิเคชันของคุณต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อส่งคำขอ API

เอกสารการค้นพบ

เอกสารการค้นพบเป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและการใช้ REST API โดยใช้เพื่อสร้างไลบรารีของไคลเอ็นต์ ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google API บริการหนึ่งๆ อาจมีเอกสารการค้นพบหลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้

ปลายทางบริการ

ปลายทางบริการคือ URL ฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งๆ อาจมีปลายทางบริการหลายรายการ บริการนี้มีปลายทางของบริการต่อไปนี้ และ URI ทั้งหมดด้านล่างจะเกี่ยวข้องกับปลายทางของบริการนี้

  • https://chat.googleapis.com

ทรัพยากร REST: v1.customEmojis

เมธอด
create POST /v1/customEmojis
สร้างอีโมจิที่กำหนดเอง
delete DELETE /v1/{name=customEmojis/*}
ลบอีโมจิที่กำหนดเอง
get GET /v1/{name=customEmojis/*}
แสดงรายละเอียดเกี่ยวกับอีโมจิที่กำหนดเอง
list GET /v1/customEmojis
แสดงรายการอีโมจิที่กำหนดเองซึ่งผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมองเห็นได้

ทรัพยากร REST: v1.media

เมธอด
download GET /v1/media/{resourceName=**}
ดาวน์โหลดสื่อ
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
อัปโหลดไฟล์แนบ

ทรัพยากร REST: v1.spaces

เมธอด
completeImport POST /v1/{name=spaces/*}:completeImport
ดำเนินการกระบวนการนำเข้าให้เสร็จสมบูรณ์สำหรับพื้นที่ทำงานที่ระบุและทำให้ผู้ใช้มองเห็นได้
create POST /v1/spaces
สร้างพื้นที่ทำงาน
delete DELETE /v1/{name=spaces/*}
ลบพื้นที่ทำงานที่มีชื่อ
findDirectMessage GET /v1/spaces:findDirectMessage
แสดงผลข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ
findGroupChats GET /v1/spaces:findGroupChats
แสดงผลพื้นที่ทำงานทั้งหมดที่มี spaceType == GROUP_CHAT ซึ่งการเป็นสมาชิกของบุคคลมีผู้ใช้ที่โทรเข้าและผู้ใช้ที่ระบุใน FindGroupChatsRequest.users เท่านั้น
get GET /v1/{name=spaces/*}
แสดงรายละเอียดเกี่ยวกับพื้นที่ทำงาน
list GET /v1/spaces
แสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก
patch PATCH /v1/{space.name=spaces/*}
อัปเดตพื้นที่ทำงาน
search GET /v1/spaces:search
แสดงรายการพื้นที่ทำงานในองค์กร Google Workspace
setup POST /v1/spaces:setup
สร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุลงในพื้นที่ทำงาน

ทรัพยากร REST: v1.spaces.members

เมธอด
create POST /v1/{parent=spaces/*}/members
สร้างการเป็นสมาชิกสำหรับแอปใน Chat ที่เรียกใช้ ผู้ใช้ หรือ Google Group
delete DELETE /v1/{name=spaces/*/members/*}
ลบการเป็นสมาชิก
get GET /v1/{name=spaces/*/members/*}
แสดงรายละเอียดเกี่ยวกับการเป็นสมาชิก
list GET /v1/{parent=spaces/*}/members
แสดงรายการการเป็นสมาชิกในพื้นที่ทำงาน
patch PATCH /v1/{membership.name=spaces/*/members/*}
อัปเดตการเป็นสมาชิก

ทรัพยากร REST: v1.spaces.messagePins

เมธอด
create POST /v1/{parent=spaces/*}/messagePins
สร้างข้อความปักหมุด
delete DELETE /v1/{name=spaces/*/messagePins/*}
ลบข้อความที่ปักหมุดไว้
list GET /v1/{parent=spaces/*}/messagePins
แสดงรายการข้อความที่ปักหมุดในพื้นที่ทำงาน

ทรัพยากร REST: v1.spaces.messages

เมธอด
create POST /v1/{parent=spaces/*}/messages
สร้างข้อความในพื้นที่ทำงานของ Google Chat
delete DELETE /v1/{name=spaces/*/messages/*}
ลบข้อความ
get GET /v1/{name=spaces/*/messages/*}
แสดงรายละเอียดเกี่ยวกับข้อความ
list GET /v1/{parent=spaces/*}/messages
แสดงข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิกอยู่ ซึ่งรวมถึงข้อความจากสมาชิกและพื้นที่ทำงานที่ถูกบล็อก
patch PATCH /v1/{message.name=spaces/*/messages/*}
อัปเดตข้อความ
replaceCards POST /v1/{name=spaces/*/messages/*}:replaceCards
แทนที่การ์ดที่รวมอยู่ในข้อความ
search POST /v1/{parent=spaces/*}/messages:search
ค้นหาข้อความใน Google Chat ที่ผู้ใช้ที่โทรเข้ามีสิทธิ์เข้าถึง
update PUT /v1/{message.name=spaces/*/messages/*}
อัปเดตข้อความ

ทรัพยากร REST: v1.spaces.messages.attachments

เมธอด
get GET /v1/{name=spaces/*/messages/*/attachments/*}
รับข้อมูลเมตาของไฟล์แนบของข้อความ

ทรัพยากร REST: v1.spaces.messages.reactions

เมธอด
create POST /v1/{parent=spaces/*/messages/*}/reactions
สร้างความรู้สึกและเพิ่มลงในข้อความ
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
ลบความรู้สึกต่อข้อความ
list GET /v1/{parent=spaces/*/messages/*}/reactions
แสดงรายการความรู้สึกต่อข้อความ

ทรัพยากร REST: v1.spaces.spaceEvents

เมธอด
get GET /v1/{name=spaces/*/spaceEvents/*}
แสดงผลเหตุการณ์จากพื้นที่ทำงานใน Google Chat
list GET /v1/{parent=spaces/*}/spaceEvents
แสดงรายการกิจกรรมจากพื้นที่ทำงานใน Google Chat

ทรัพยากร REST: v1.users.availability

เมธอด
get GET /v1/{name=users/*/availability}
แสดงข้อมูลเวลาว่างของผู้ใช้ที่เป็นมนุษย์ใน Google Chat
markAsActive POST /v1/{name=users/*/availability}:markAsActive
ทำเครื่องหมายผู้ใช้เป็นACTIVEใน Google Chat
markAsAway POST /v1/{name=users/*/availability}:markAsAway
ทำเครื่องหมายผู้ใช้เป็นAWAYใน Google Chat
markAsDoNotDisturb POST /v1/{name=users/*/availability}:markAsDoNotDisturb
ทำเครื่องหมายผู้ใช้เป็นDO_NOT_DISTURBใน Google Chat
patch PATCH /v1/{availability.name=users/*/availability}
อัปเดตข้อมูลเวลาว่างของผู้ใช้ที่เป็นมนุษย์

ทรัพยากร REST: v1.users.sections

เมธอด
create POST /v1/{parent=users/*}/sections
สร้างส่วนใน Google Chat
delete DELETE /v1/{name=users/*/sections/*}
ลบส่วนของประเภท CUSTOM_SECTION
list GET /v1/{parent=users/*}/sections
แสดงรายการส่วนที่พร้อมใช้งานสำหรับผู้ใช้ Chat
patch PATCH /v1/{section.name=users/*/sections/*}
อัปเดตส่วน
position POST /v1/{name=users/*/sections/*}:position
เปลี่ยนลำดับการจัดเรียงของส่วน

ทรัพยากร REST: v1.users.sections.items

เมธอด
list GET /v1/{parent=users/*/sections/*}/items
แสดงรายการในส่วน
move POST /v1/{name=users/*/sections/*/items/*}:move
ย้ายรายการจากส่วนหนึ่งไปยังอีกส่วนหนึ่ง

ทรัพยากร REST: v1.users.spaces

เมธอด
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
แสดงรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
อัปเดตสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน

ทรัพยากร REST: v1.users.spaces.spaceNotificationSetting

เมธอด
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
รับการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
อัปเดตการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน

ทรัพยากร REST: v1.users.spaces.threads

เมธอด
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
แสดงรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน