次の方法で共有

presence: setStatusMessage

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ユーザーのプレゼンス 状態メッセージを設定します。 省略可能な有効期限の日付と時刻を指定できます。

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

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

アクセス許可

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

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

HTTP 要求

POST /users/{userId}/presence/setStatusMessage

要求ヘッダー

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

要求本文

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

パラメーター 型 説明
statusMessage microsoft.graph.presenceStatusMessage ユーザーのプレゼンス状態メッセージが含まれます。

応答

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

例

例 1: 有効期限を使用してステータス メッセージを設定する

次の要求は、プレゼンス状態メッセージを "現在会議中です" としてユーザー fa8bf3dc-eca7-46b7-bad1-db199b62afc3に設定します。有効期限 2022-10-18 at 17:05:33.2079781 Pacific Standard Timeは です。

要求

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

{
  "statusMessage": {
    "message": {
        "content": "Hey I'm currently in a meeting.",
        "contentType": "text"
    },
    "expiryDateTime": {
        "dateTime": "2022-10-18T17:05:33.2079781",
        "timeZone": "Pacific Standard Time"
    }
  }
}

応答

HTTP/1.1 200 OK

例 2: 別のユーザーの状態メッセージを設定する

次の要求は、プレゼンス状態メッセージをユーザーに対して "Hey I is available now" として設定します fa8bf3dc-eca7-46b7-bad1-db199b62afc3。 例 3 では、ユーザー fa8bf3dc-eca7-46b7-bad1-db199b62afc3 のプレゼンス情報は 、getPresence 要求を介して別のユーザーの代わりに取得されます。

要求

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

{
  "statusMessage": {
    "message": {
      "content": "Hey I am available now",
      "contentType": "text"
    }
  }
}

応答

HTTP/1.1 200 OK

例 3: 別のユーザー プレゼンスを取得する

この例は、例 2 に従います。 ユーザー fa8bf3dc-eca7-46b7-bad1-db199b62afc3 のプレゼンス情報は、 getPresence 要求を介して別のユーザーに代わって取得されます。

要求

GET https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence

応答

この要求は別のユーザーのプレゼンス状態を取得するため、 statusMessage.expiryDateTime プロパティと statusMessage.publishedDateTime プロパティは応答本文に含まれません。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "fa8bf3dc-eca7-46b7-bad1-db199b62afc3",
  "availability": "Available",
  "activity": "Available",
  "outOfOfficeSettings": {
    "message": null,
    "isOutOfOffice": false
  },
  "statusMessage": {
    "message": {
      "content": "Hey I am available now",
      "contentType": "text"
    }
  }
}