您可以透過 Google Chat API 建構 Chat 擴充應用程式,將您的服務與 Google Chat 整合,並管理聊天室、成員和訊息等 Chat 資源。
- REST 資源:v1.customEmojis
- REST 資源:v1.media
- REST 資源:v1.spaces
- REST 資源:v1.spaces.members
- REST 資源:v1.spaces.messages
- REST 資源:v1.spaces.messages.attachments
- REST 資源:v1.spaces.messages.reactions
- REST 資源:v1.spaces.spaceEvents
- REST 資源:v1.users.spaces
- REST 資源:v1.users.spaces.spaceNotificationSetting
- REST 資源:v1.users.spaces.threads
服務:chat.googleapis.com
如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫呼叫這項服務,請在發出 API 要求時使用下列資訊。
導覽文件
導覽文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件:
服務端點
服務端點是指定 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.memberships中指定的使用者。 | 
| 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 群組建立成員資格。 | 
| 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.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/*}更新訊息。 | 
| 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.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}傳回有關執行緒中使用者讀取狀態的詳細資料,用於識別已讀和未讀訊息。 |