Freigeben über


Teamwork: sendActivityNotificationToRecipients

Namespace: microsoft.graph

Senden von Aktivitätsfeedbenachrichtigungen an mehrere Benutzer in einem Massenvorgang.

Weitere Informationen finden Sie unter Senden von Teams-Aktivitätsbenachrichtigungen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) TeamsActivity.Send Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung TeamsActivity.Send.User TeamsActivity.Send

Anmerkung: Die TeamsActivity.Send.User Berechtigung verwendet die ressourcenspezifische Zustimmung. RSC-Berechtigungen beziehen sich auf die einzelnen Empfänger in der Nutzlast.

HTTP-Anforderung

POST /teamwork/sendActivityNotificationToRecipients

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Hinweis: Das bereitgestellte Token muss mindestens 45 Minuten nach ablaufen. Der API-Aufruf gibt eine 412 Precondition Failed Antwort zurück, wenn das Token innerhalb von 45 Minuten abläuft.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die mit dieser Aktion verwendet werden können.

Parameter Typ Beschreibung
Thema teamworkActivityTopic Das Thema der Benachrichtigung. Gibt die Ressource an, über die gesprochen wird.
activityType Zeichenfolge Der Aktivitätstyp muss im Teams-App-Manifest deklariert werden, mit Ausnahme des systemDefaultAktivitätstyps Reserviert, der Freiformtext in der Actor+Reason Zeile der Benachrichtigung bereitstellt.
chainId Int64 Optional. Die Ketten-ID der Benachrichtigung. Wird verwendet, um eine vorherige Benachrichtigung zu überschreiben. Verwenden Sie dasselbe chainId in nachfolgenden Anforderungen, um die vorherige Benachrichtigung zu überschreiben.
previewText itemBody Der Vorschautext für die Benachrichtigung. Microsoft Teams zeigt nur die ersten 150 Zeichen an.
templateParameters keyValuePair-Sammlung Die Werte für die Vorlagenvariablen, die im Aktivitätsfeedeintrag definiert sind, activityType der im Teams-App-Manifest entspricht.
teamsAppId Zeichenfolge Optional. Die Teams-App-ID der Teams-App, die der Benachrichtigung zugeordnet ist. Wird verwendet, um installierte Apps zu unterscheiden, wenn mehrere Apps mit der gleichen Microsoft Entra ID-App-ID für denselben Empfängerbenutzer installiert werden. Vermeiden Sie die Freigabe von Microsoft Entra ID-App-IDs zwischen Teams-Apps.
recipients teamworkNotificationRecipient-Sammlung Empfänger der Benachrichtigung. Nur Empfänger vom Typ aadUserNotificationRecipient werden unterstützt. Es gibt eine Obergrenze von 100 Empfängern in einer einzelnen Anforderung.

Die folgende Ressource wird unterstützt, wenn der source Wert der Topic-Eigenschaft auf entityUrlfestgelegt wird:

Antwort

Wenn die Aktion erfolgreich verläuft, wird der Antwortcode 202 Accepted zurückgegeben.

Beispiele

Beispiel 1: Benachrichtigen mehrerer Benutzer über ausstehende Finanzgenehmigungsanforderungen

Das folgende Beispiel zeigt, wie Eine Aktivitätsfeedbenachrichtigung massenweise an mehrere Benutzer gesendet wird. In diesem Beispiel werden mehrere Projektbeteiligte über ausstehende Finanzgenehmigungsanforderungen benachrichtigt.

Anforderung

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"
        }
    ] 
}

Antwort

HTTP/1.1 202 Accepted

Beispiel 2: Benachrichtigen mehrerer Benutzer über ein Ereignis mithilfe eines benutzerdefinierten Themas

Wenn Sie einen Aspekt verknüpfen möchten, der nicht von Microsoft Graph dargestellt wird, oder wenn Sie den Namen anpassen möchten, können Sie die Quelle für topictext festlegen und einen benutzerdefinierten Wert dafür übergeben. webUrl ist erforderlich, wenn source als textverwendet topic wird.

Anforderung

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"
    	}
    ]
}

Antwort

HTTP/1.1 202 Accepted