次の方法で共有

teamwork: sendActivityNotificationToRecipients

  • [アーティクル]

名前空間: microsoft.graph

アクティビティ フィード通知を複数のユーザーに一括で送信します。

詳細については、「 Teams アクティビティ通知の送信」を参照してください。

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

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

アクセス許可

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

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

手記：TeamsActivity.Send.Userアクセス許可では、リソース固有の同意が使用されます。 RSC アクセス許可は、ペイロード内の個々の受信者に関連します。

HTTP 要求

POST /teamwork/sendActivityNotificationToRecipients

要求ヘッダー

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

注: 提供されるトークンは、有効期限から少なくとも 45 分である必要があります。 API 呼び出しは、トークンが 45 分以内に期限切れになると、 412 Precondition Failed 応答を返します。

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

次の表に、このアクションで使用できるパラメーターを示します。

パラメーター 種類 説明
topic teamworkActivityTopic 通知のトピック。 話し合うリソースを指定します。
activityType String アクティビティの種類は、通知のActor+Reason行に自由形式のテキストを提供するsystemDefault予約済みアクティビティの種類を除き、Teams アプリ マニフェストで宣言する必要があります。
chainId Int64 省略可能。 通知のチェーン ID。 以前の通知をオーバーライドするために使用されます。 後続の要求でも同じ chainId を使用して、前の通知をオーバーライドします。
previewText itemBody 通知のプレビュー テキスト。 Microsoft Teams最初の 150 文字のみが表示されます。
templateParameters keyValuePair コレクション Teams アプリ マニフェストのactivityTypeに対応するアクティビティ フィード エントリで定義されているテンプレート変数の値。
teamsAppId String 省略可能。 通知に関連付けられている Teams アプリの Teams アプリ ID。 同じ受信者ユーザーに対して同じ Microsoft Entra ID アプリ ID を持つ複数のアプリがインストールされている場合に、インストールされているアプリを明確にするために使用されます。 Teams アプリ間で Microsoft Entra ID アプリ ID を共有しないようにします。
Recipients teamworkNotificationRecipient コレクション 通知の受信者。 aadUserNotificationRecipient 型の受信者のみがサポートされます。 1 回の要求には 100 人の受信者の上限があります。

トピック プロパティのsource値を entityUrl に設定する場合、次のリソースがサポートされます。

応答

成功した場合、このアクションは 202 Accepted 応答コードを返します。

例

例 1: 保留中の財務承認要求について複数のユーザーに通知する

次の例は、アクティビティ フィード通知を複数のユーザーに一括で送信する方法を示しています。 この例では、保留中の財務承認要求について複数の利害関係者に通知します。

要求

POST https://graph.microsoft.com/v1.0/teamwork/sendActivityNotificationToRecipients
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/{teamsAppId}"
    },
    "activityType": "pendingFinanceApprovalRequests",
    "previewText": {
        "content": "Internal spending team has a pending finance approval requests"
    },
    "recipients": [
    	{
        	"@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        	"userId": "569363e2-4e49-4661-87f2-16f245c5d66a"
    	},
    	{
        	"@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        	"userId": "ab88234e-0874-477c-9638-d144296ed04f"
    	},
    	{
        	"@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        	"userId": "01c64f53-69aa-42c7-9b7f-9f75195d6bfc"
    	}
    ],
    "templateParameters": [
        {
            "name": "pendingRequestCount",
            "value": "5"
        }
    ] 
}

応答

HTTP/1.1 202 Accepted

例 2: カスタム トピックを使用してイベントについて複数のユーザーに通知する

Microsoft Graph で表されていないアスペクトをリンクする場合、または名前をカスタマイズする場合は、topicのソースをtextに設定し、カスタム値を渡すことができます。textとしてソースtopic使用する場合は、webUrl が必要です。

要求

POST https://graph.microsoft.com/v1.0/teamwork/sendActivityNotificationToRecipients
Content-Type: application/json

{
    "topic": {
        "source": "text",
        "value": "Deployment Approvals Channel",
        "webUrl": "https://teams.microsoft.com/l/message/19:448cfd2ac2a7490a9084a9ed14cttr78c@thread.skype/1605223780000?tenantId=c8b1bf45-3834-4ecf-971a-b4c755ee677d&groupId=d4c2a937-f097-435a-bc91-5c1683ca7245&parentMessageId=1605223771864&teamName=Approvals&channelName=Azure%20DevOps&createdTime=1605223780000"
    },
    "activityType": "deploymentApprovalRequired",
    "previewText": {
        "content": "New deployment requires your approval"
    },
    "templateParameters": [
        {
            "name": "deploymentId",
            "value": "6788662"
        }
    ],
    "recipients": [
    	{
        	"@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        	"userId": "569363e2-4e49-4661-87f2-16f245c5d66a"
    	},
    	{
        	"@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        	"userId": "ab88234e-0874-477c-9638-d144296ed04f"
    	},
    	{
        	"@odata.type": "microsoft.graph.aadUserNotificationRecipient",
        	"userId": "01c64f53-69aa-42c7-9b7f-9f75195d6bfc"
    	}
    ]
}

応答

HTTP/1.1 202 Accepted