userTeamwork: sendActivityNotification

Namespace: microsoft.graph

Senden Sie eine Aktivitätsfeedbenachrichtigung an einen Benutzer. Weitere Informationen zum Senden von Benachrichtigungen und zu den Anforderungen hierfür finden Sie unter Senden Teams Aktivitätsbenachrichtigungen.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) TeamsActivity.Send
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt.
Anwendung TeamsActivity.Send

HTTP-Anforderung

POST /users/{userId | user-principal-name}/teamwork/sendActivityNotification

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie als 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 Thema der Benachrichtigung. Gibt die Ressource an, über die gesprochen wird.
activityType String Aktivitätstyp. Dies muss im Teams App-Manifest deklariert werden.
chainId Int64 Optional. Wird verwendet, um eine vorherige Benachrichtigung zu überschreiben. Verwenden Sie dasselbe chainId in nachfolgenden Anforderungen, um die vorherige Benachrichtigung zu überschreiben.
previewText itemBody Vorschautext für die Benachrichtigung. Microsoft Teams werden nur die ersten 150 Zeichen angezeigt.
templateParameters keyValuePair-Sammlung Werte für Vorlagenvariablen, die im Aktivitätsfeedeintrag definiert sind, der activityType in Teams App-Manifest entspricht.

Die folgenden Ressourcen werden beim Festlegen source des Werts der Themeneigenschaft unterstützt entityUrl:

Antwort

Wenn die Aktion erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben.

Beispiele

Beispiel 1: Senden einer Benachrichtigung an einen Benutzer für eine erstellte Aufgabe

Anforderung

POST https://graph.microsoft.com/v1.0/users/{userId}/teamwork/sendActivityNotification
Content-Type: application/json

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/v1.0/users/{userId}/teamwork/installedApps/{installationId}"
    },
    "activityType": "taskCreated",
    "previewText": {
        "content": "New Task Created"
    },
    "templateParameters": [
        {
            "name": "taskId",
            "value": "Task 12322"
        }
    ]
}

Antwort

HTTP/1.1 204 No Content

Beispiel 2: Benachrichtigen eines Benutzers ü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 das topic text Element festlegen und einen benutzerdefinierten Wert dafür übergeben. webUrl ist erforderlich, wenn topic Quelle als textverwendet wird.

Anforderung

POST https://graph.microsoft.com/v1.0/users/{userId}/teamwork/sendActivityNotification
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"
        }
    ]
}

Antwort

HTTP/1.1 204 No Content