Method: users.availability.markAsDoNotDisturb

在 Google Chat 中将用户标记为 DO_NOT_DISTURB。

将用户的空闲状态设置为 DO_NOT_DISTURB，直到指定的过期时间。在 DO_NOT_DISTURB 模式下，用户通常不会收到通知。

此方法仅更新经过身份验证的用户的空闲情况。

需要使用授权范围进行用户身份验证：

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要标记为“勿扰”的空闲时间的资源名称。格式：users/{user}/availability

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

用户的电子邮件地址或 me 也可用作别名来指代调用者。例如 users/user@example.com 或 users/me。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{

  "expireTime": string,
  "ttl": string
}
字段
联合字段 expiration。必需。“请勿打扰”空闲状态的过期时间。订阅到期后，用户将被标记为“不在”。此日期最久距当前时间 1 年为限。expiration 只能是下列其中一项：
expireTime

string (Timestamp format)

“请勿打扰”状态失效的绝对时间戳。
ttl

string (Duration format)

从当前时间到“请勿打扰”状态结束的时间段。

响应正文

如果成功，则响应正文包含一个 Availability 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅授权指南。