Method: users.availability.get

傳回 Google Chat 中真人使用者的有空與否資訊。舉例來說,您可以藉此檢查使用者是否在線上或離開,或是擷取自訂狀態訊息。

這個方法只會擷取通過驗證的使用者是否有空。

需要使用者驗證,並使用下列其中一個授權範圍

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability

HTTP 要求

GET https://chat.googleapis.com/v1/{name=users/*/availability}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

必填。要擷取的供應情形資源名稱。

格式:users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中 Person 的 ID。例如:users/123456789

使用者的電子郵件地址或 me 也可做為別名,用來指稱來電者。例如 users/user@example.comusers/me

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會包含 Availability 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/chat.users.availability
  • https://www.googleapis.com/auth/chat.users.availability.readonly

詳情請參閱授權指南