presence: setPresence

[アーティクル]
04/05/2024

名前空間: microsoft.graph

重要

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

ユーザーのアプリケーションのプレゼンスセッションで可用性とアクティビティの状態を設定します。

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

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

プレゼンスセッション

ユーザーは複数の Teams クライアント (デスクトップ、モバイル、Web) 上に存在できるため、ユーザーは複数のプレゼンスセッションを持つことができます。各 Teams クライアントには独立したプレゼンスセッションがあり、ユーザーのプレゼンスは、背後にあるすべてのセッションから集計された状態です。

同様に、アプリケーションはユーザーに対して独自のプレゼンスセッションを持ち、状態を更新できます。

セッション状態の集計方法の優先順位を次に示します。"A > B" は A が B よりも優先されます。

ユーザー優先状態 > セッションレベルの状態 (ユーザー優先状態はセッションレベルの状態をオーバーライドします)
セッションレベルの状態の間: DoNotDisturb > Busy > Available > Away

メモ： Microsoft Graph でユーザープレゼンスが変更されると、Teams クライアントがポーリングモードを使用するため、プレゼンス状態の更新には数分かかります。

タイムアウト、有効期限、およびキープアライブ

プレゼンスセッションが タイムアウト して 有効期限が切れる可能性があるため、アプリケーションは タイムアウト前にこの API を呼び出して、セッションの状態を維持する必要があります。または 有効期限の前に、セッションを維持します。

プレゼンスセッションは、可用性がであり、タイムアウトが Available 5 分である場合にタイムアウトになる可能性があります。タイムアウトすると、プレゼンス状態は段階的にフェードします。たとえば、アプリケーションがプレゼンスセッションをとして Available/Available設定した場合、状態は最初のタイムアウトで 5 分後、 Available/AvailableInactive 2 回目のタイムアウト Away/Away でさらに 5 分でに変わります。

プレゼンスセッションの有効期限は、パラメーターで expirationDuration 構成できます。セッションの有効期限が切れると、 Offlineになります。

アクセス許可

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

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

HTTP 要求

POST /users/{userId}/presence/setPresence

要求ヘッダー

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

要求本文

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

パラメーター	型	説明
Sessionid	string	アプリケーションのプレゼンスセッションの ID。
availability	string	ベースプレゼンス情報。
アクティビティ	文字列	可用性に関する補足情報。
expirationDuration	duration	アプリプレゼンスセッションの有効期限。値は ISO 8601 形式で表示されます。指定しない場合は、既定の有効期限 5 分が適用されます。

重要

要求と同様 sessionId に、アプリケーションの ID を指定します。

サポートされていると activity のavailability組み合わせは次のとおりです。

availability	アクティビティ	説明
使用可能	使用可能	プレゼンスセッションを [使用可能] としてUpdatesします。
多忙	InACall	プレゼンスセッションを [ビジー] (InACall) としてUpdatesします。
多忙	InAConferenceCall	プレゼンスセッションを [ビジー] (InAConferenceCall) としてUpdatesします。
離れて	離れて	プレゼンスセッションを [退席] としてUpdatesします。
DoNotDisturb	提示	プレゼンスセッションを DoNotDisturb、Presenting としてUpdatesします。

応答

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

例

次の要求は、ユーザーfa8bf3dc-eca7-46b7-bad1-db199b62afc3のプレゼンスセッションを設定する ID を22553876-f5ab-4529-bffb-cfe50aa89f87持つアプリケーションを示しています。

要求

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

{
  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87",
  "availability": "Available",
  "activity": "Available",
  "expirationDuration": "PT1H"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Users.Item.Presence.SetPresence;

var requestBody = new SetPresencePostRequestBody
{
	SessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87",
	Availability = "Available",
	Activity = "Available",
	ExpirationDuration = TimeSpan.Parse("PT1H"),
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Users["{user-id}"].Presence.SetPresence.PostAsync(requestBody);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta users presence set-presence post --user-id {user-id} --body '{\
  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87",\
  "availability": "Available",\
  "activity": "Available",\
  "expirationDuration": "PT1H"\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
	  //other-imports
)

requestBody := graphusers.NewSetPresencePostRequestBody()
sessionId := "22553876-f5ab-4529-bffb-cfe50aa89f87"
requestBody.SetSessionId(&sessionId) 
availability := "Available"
requestBody.SetAvailability(&availability) 
activity := "Available"
requestBody.SetActivity(&activity) 
expirationDuration , err := abstractions.ParseISODuration("PT1H")
requestBody.SetExpirationDuration(&expirationDuration) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Users().ByUserId("user-id").Presence().SetPresence().Post(context.Background(), requestBody, nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.users.item.presence.setpresence.SetPresencePostRequestBody setPresencePostRequestBody = new com.microsoft.graph.beta.users.item.presence.setpresence.SetPresencePostRequestBody();
setPresencePostRequestBody.setSessionId("22553876-f5ab-4529-bffb-cfe50aa89f87");
setPresencePostRequestBody.setAvailability("Available");
setPresencePostRequestBody.setActivity("Available");
PeriodAndDuration expirationDuration = PeriodAndDuration.ofDuration(Duration.parse("PT1H"));
setPresencePostRequestBody.setExpirationDuration(expirationDuration);
graphClient.users().byUserId("{user-id}").presence().setPresence().post(setPresencePostRequestBody);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const setPresence = {
  sessionId: '22553876-f5ab-4529-bffb-cfe50aa89f87',
  availability: 'Available',
  activity: 'Available',
  expirationDuration: 'PT1H'
};

await client.api('/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence')
	.version('beta')
	.post(setPresence);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Presence\SetPresence\SetPresencePostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SetPresencePostRequestBody();
$requestBody->setSessionId('22553876-f5ab-4529-bffb-cfe50aa89f87');
$requestBody->setAvailability('Available');
$requestBody->setActivity('Available');
$requestBody->setExpirationDuration(new \DateInterval('PT1H'));

$graphServiceClient->users()->byUserId('user-id')->presence()->setPresence()->post($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Users.Actions

$params = @{
	sessionId = "22553876-f5ab-4529-bffb-cfe50aa89f87"
	availability = "Available"
	activity = "Available"
	expirationDuration = "PT1H"
}

Set-MgBetaUserPresence -UserId $userId -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.presence.set_presence.set_presence_post_request_body import SetPresencePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = SetPresencePostRequestBody(
	session_id = "22553876-f5ab-4529-bffb-cfe50aa89f87",
	availability = "Available",
	activity = "Available",
	expiration_duration = "PT1H",
)

await graph_client.users.by_user_id('user-id').presence.set_presence.post(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

HTTP/1.1 200 OK

次の方法で共有

presence: setPresence

プレゼンスセッション

タイムアウト、有効期限、およびキープアライブ

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

次の方法で共有

presence: setPresence

プレゼンス セッション

タイムアウト、有効期限、およびキープ アライブ

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース

プレゼンスセッション

タイムアウト、有効期限、およびキープアライブ