本節說明 Google Chat 應用程式如何呼叫 Chat API,進而讓 Chat 擴充應用程式執行多項操作,例如建立聊天室、將使用者新增至聊天室,以及在不看到 Chat 應用程式互動事件提示的情況下張貼訊息。
驗證機制
如要以非同步方式呼叫 Chat API,必須進行驗證。每個 Chat API 方法都需要使用者驗證 (以代表使用者執行動作或存取資料) 或應用程式驗證 (以 Chat 應用程式的形式執行動作或存取資料)。有些方法支援使用者驗證和應用程式驗證。
如要進一步瞭解 Chat 中的驗證,請參閱驗證總覽。
API 資源與方法
REST 資源和方法授權讓人員以非同步方式存取 Chat 聊天室、聊天室成員、訊息、訊息回應和訊息附件。
- 聊天室
聊天室是使用者和應用程式對話及分享檔案的空間。聊天室有多種類型。即時訊息 (DM) 是兩名使用者或使用者和 Chat 應用程式之間的 1:1 對話。群組通訊是指三名以上使用者和 Chat 應用程式之間的對話。已命名的聊天室 是使用者傳送訊息、分享檔案及協同合作的永久位置
spaces
資源代表聊天室。聊天室支援下列方法:
- 建立聊天室,供使用者和應用程式對話及分享檔案。
- 設定聊天室以建立聊天室,並在該聊天室中新增成員和 Chat 應用程式。
- 取得聊天室以查看聊天室的詳細資料。
- 列出空格,即可查看可篩選的分頁聊天室清單。
- 更新聊天室可變更聊天室的屬性,例如該聊天室的顯示名稱、說明和規範。
- 您可以刪除不再需要的聊天室。
- 尋找即時訊息 (DM) 以傳回兩個使用者之間的即時訊息,或使用者與呼叫 Chat 應用程式之間的即時訊息。
- 成員
「成員」是指已加入或受邀加入聊天室的使用者和 Chat 擴充應用程式。
spaces.members
資源代表成員。成員支援下列方法:
- 訊息
spaces.messages
資源代表訊息。「訊息」支援下列方法:
- 反應
回應代表使用者用來回應訊息的表情符號,例如 👍?、🚲? 以及 Θ。
回應支援下列方法:
- 媒體與附件
「Media」代表上傳到 Google Chat 的檔案,例如圖片、影片和文件。
media
資源代表訊息附加的媒體。附件是附加在郵件中的媒體 (檔案) 例項。
spaces.messages.attachments
資源代表連結。附件會包含媒體及附加至訊息的相關中繼資料。媒體和附件支援下列方法:
- 聊天室活動
聊天室事件代表聊天室或其子項資源的變更,包括聊天室的成員、訊息和回應。
spaces.spaceEvent
資源代表聊天室活動。聊天室事件支援下列方法:
- 使用者讀取狀態
使用者讀取狀態是單例模式資源,代表在 Google Chat 聊天室或訊息執行緒中,指定使用者上次讀取訊息的詳細資料。
users.spaces
資源代表使用者在聊天室中的讀取狀態。users.spaces.threads
資源代表使用者在訊息執行緒中的讀取狀態。使用者讀取狀態支援下列方法: