presence:setUserPreferredPresence

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

设置用户的首选可用性和活动状态。 如果设置了用户的首选状态,则用户的状态是首选状态。

仅当用户至少有一个 状态会话 时,首选状态才会生效。 否则,用户的状态将保持为脱机状态。

如果 setPresence 操作成功,或者用户在 Teams 客户端上登录,则可以创建状态会话。

详细了解 状态会话 及其 超时和过期

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Presence.ReadWrite 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Presence.ReadWrite.All 不可用。

HTTP 请求

POST /users/{userId}/presence/setUserPreferredPresence

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
availability string 基本状态信息。
活动 string 可用性的补充信息。
expirationDuration duration 应用状态会话的过期时间。 该值在持续时间内以 ISO 8601 格式表示。
如果未提供,将应用默认过期时间:
DoNotDisturb 或忙碌:1 天后过期
所有其他:7 天后过期

支持的可用性和活动组合包括:

availability 活动 说明
可用 可用 将用户首选状态设置为“可用”。
忙碌 忙碌 将用户首选状态设置为“忙碌”。
DoNotDisturb DoNotDisturb 将用户首选状态设置为 DoNotDisturb。
BeRightBack BeRightBack 将用户首选状态设置为 BeRightBack。
离开 离开 将用户首选状态设置为“离开”。
Offline OffWork 将用户首选状态设置为“脱机”。

响应

如果成功,此方法返回 200 OK 响应代码。

示例

以下请求将用户的首选状态设置为用户 的 fa8bf3dc-eca7-46b7-bad1-db199b62afc3DoNotDisturb,有效期为 8 小时。

请求

POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setUserPreferredPresence
Content-Type: application/json

{
  "availability": "DoNotDisturb",
  "activity": "DoNotDisturb",
  "expirationDuration": "PT8H"
}

响应

HTTP/1.1 200 OK