次の方法で共有


presence: setUserPreferredPresence

名前空間: microsoft.graph

ユーザーの優先可用性とアクティビティの状態を設定します。 ユーザーの優先プレゼンスが設定されている場合、ユーザーのプレゼンスは優先状態として表示されます。

優先プレゼンスは、ユーザーに少なくとも 1 つの プレゼンス セッション が存在する場合にのみ有効になります。 それ以外の場合、ユーザーのプレゼンスは として Offline表示されます。

プレゼンス セッションは、 setPresence 操作が成功した結果、またはユーザーが Microsoft Teams クライアントにサインインした場合に作成されます。

詳細については、「 プレゼンス セッションタイムアウトと有効期限」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) Presence.ReadWrite 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Presence.ReadWrite.All 注意事項なし。

HTTP 要求

POST /users/{userId}/presence/setUserPreferredPresence

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 説明
アクティビティ String 可用性に関する補足情報。
availability String ベース プレゼンス情報。
expirationDuration 期間 ISO 8601 形式で表されるアプリ プレゼンス セッションの有効期限 。
指定しない場合は、既定の有効期限が適用されます。
- DoNotDisturb または Busy: 1 日の有効期限
- その他: 7 日間の有効期限

次の表に、 サポートされている可用性 とアクティビティの組み合わせを示 します

availability アクティビティ 説明
使用可能 使用可能 ユーザーの優先プレゼンスを として Available設定します。
多忙 多忙 ユーザーの優先プレゼンスを として Busy設定します。
DoNotDisturb DoNotDisturb ユーザーの優先プレゼンスを として DoNotDisturb設定します。
BeRightBack BeRightBack ユーザーの優先プレゼンスを として BeRightBack設定します。
離れて 離れて ユーザーの優先プレゼンスを として Away設定します。
オフライン OffWork ユーザーの優先プレゼンスを として Offline設定します。

応答

成功した場合、このメソッドは 200 OK 応答コードを返します。

要求

次の例は、ユーザーに対して優先プレゼンス DoNotDisturb を設定する要求を示しています。有効期限は 8 時間です。

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

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

応答

次の例は応答を示しています。

HTTP/1.1 200 OK