teamwork：sendActivityNotificationToRecipients

  • 项目

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

批量向多个用户发送活动源通知。

有关详细信息，请参阅 发送 Teams 活动通知。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） TeamsActivity.Send 不可用。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 TeamsActivity.Send.User TeamsActivity.Send

注意： 权限 TeamsActivity.Send.User 使用 特定于资源的许可。 RSC 权限与有效负载中的单个收件人相关。

HTTP 请求

POST /teamwork/sendActivityNotificationToRecipients

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

注意：提供的令牌必须在过期后至少 45 分钟。 如果令牌在 45 分钟内过期，API 调用将返回 412 Precondition Failed 响应。

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表显示了可用于此操作的参数。

参数 类型 说明
topic teamworkActivityTopic 通知的主题。 指定要讨论的资源。
activityType String 活动类型必须在 Teams 应用清单中声明，保留活动类型除外systemDefault，后者在通知行中Actor+Reason提供自由格式文本。
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 类型的收件人。 单个请求中的收件人上限为 100 个。

将 topic 属性entityUrl的值设置为 source 时，支持以下资源：

响应

如果成功，此操作返回 202 Accepted 响应代码。

示例

示例 1：通知多个用户有关待处理的财务审批请求

以下示例演示如何批量向多个用户发送活动源通知。 此示例通知多个利益干系人有关待处理的财务审批请求。

请求

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

{
    "topic": {
        "source": "entityUrl",
        "value": "https://graph.microsoft.com/beta/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 不表示的方面，或者想要自定义名称，可以将 的topictext源设置为 并为其传递自定义值。 webUrl 使用 topic 源作为 text时是必需的。

请求

POST https://graph.microsoft.com/beta/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