使用可操作邮件开发人员仪表板注册服务

重要

由于服务升级,具有 全局 范围的新可操作消息提供程序的加入将暂时暂停到 2024 年 6 月 30 日。 现有的全球范围提供程序以及组织和测试范围提供程序的加入不受影响。 有关详细信息,请参阅 可操作消息的常见问题解答

若要测试和发布服务中的可操作邮件,需要向 Microsoft 提供某些信息,以便为来自服务的电子邮件启用此功能。 开发人员仪表板可帮助你通过 Web 门户提交和跟踪提交状态。

注意

通过向自己发送带有所需标记的电子邮件,无需 Microsoft 进行任何干预,即可轻松尝试通过电子邮件发送可操作邮件。 这通常是你初步接触此功能时尝试体验的第一步。 查看这些示例以将可操作邮件发送到邮箱,或使用可操作邮件Designer向自己发送可操作邮件。

作为通过电子邮件处理可操作邮件的开发人员,可将此门户用于以下情况:

  • 测试从你的服务发送到你自己的邮箱的可操作邮件
  • 从你的服务发布可操作邮件,以便你的组织内使用 Office 365 的所有电子邮件用户均可收到这些特殊格式的邮件(此操作通常用于在特定于组织的服务中启用可操作邮件,例如业务线应用)
  • 从你的服务发布可操作邮件,以便 Office 365 中使用你的服务的任何电子邮件用户均可收到这些特殊格式的邮件

对于上述所有场景,均要向 Microsoft 提交某些详细信息,在这些信息经过审查并得到批准后,则将为你的服务启用可操作邮件。

仪表板组成部分

开发人员仪表板分为几个逻辑部分,你需要根据自己向 Microsoft 申请的要在服务中启用的可操作邮件的范围来填写它们。

提供程序的详细信息

在此部分中,需要提供关键详细信息,以使 Office 365 可以接受包含你的服务标记及 URL(可通过这些电子邮件的操作按钮调用它们)的电子邮件。

关键字段为:

  • 发件人电子邮件地址:这是将发出包含操作标记的电子邮件的服务对应的一个或多个静态电子邮件地址。 示例:myservice@contoso.com

  • 目标 URL:这是与将处理操作的 URL 对应的一个或多个域。 目标 URL 可以对应于 TLD 的顶级域或子域。 它们必须为启用了 https 的 URL。 例子。 https://api.myservice.com.

  • 公钥:如果计划以签名卡的形式发送可操作的邮件,则需要指定与要用于对卡签名的私钥相对应的公钥。 此字段的格式是一个 RSAKeyValue 元素

    <RSAKeyValue>
      <Modulus>xA7SEU+e0yQ...</Modulus>
      <Exponent>AQAB</Exponent>
    </RSAKeyValue>
    

可以使用 PowerShell (7.3 或更高版本生成和导出 RSA 密钥对,) :

# Generate a key pair:
$rsa = [System.Security.Cryptography.RSA]::Create();

# Private Key, ensure this is saved securely and kept secret:
$rsa.ToXmlString($true)

## Public Key, copy output to dashboard:
$rsa.ToXmlString($false)

有关如何从 .cert 文件获取公钥 XML 的示例,请参阅 PublicKey 类

注意

提交获得批准后,可能需要一些时间才能生效。 如果在发送已签名卡时遇到以下错误,并且确定有效负载正确,请在几小时后重试。

Adaptive card signature validation failed - Failed to validate signature

提交范围

在此部分中,需要指定要为你的服务启用的可操作邮件的范围。 适用的范围是:

  • 测试用户:此范围启用从你的服务发送到组织中的某些 O365 电子邮件用户的可操作邮件。 此范围通常用于测试可操作的消息与你所指定的少数测试用户的集成。
  • 组织:此范围启用从你的服务发送到你的组织内任意 Microsoft 365 电子邮件用户的可操作邮件。 此范围通常用于在特定于组织的服务中启用可操作邮件,例如组织内部的业务线应用程序。
  • 全局:此范围启用从你的服务到 Office 365 中任意电子邮件用户的可操作邮件。

上述每个都是独立的步骤。 即,每次提交只能选择一个范围,并受 Microsoft 审批流程的约束。

注意

请记住,你可以通过向自己发送带有所需标记的电子邮件来轻松试用可操作邮件,而无需 Microsoft 进行任何干预。 可以使用可操作消息Designer发送给自己,而无需编写任何代码。 这通常是尝试体验可操作邮件的第一步。

自助注册

自助注册适用于使用以下范围的注册。

  • 测试用户:会自动批准你指定的测试用户的注册请求。 此范围将启用从你的服务发送到测试用户的可操作邮件。
  • 组织: 此注册请求将发送给你的组织中具有 Exchange 管理员 权限的管理员。 具有这些权限的所有管理员都会收到一封包含提交详细信息的电子邮件,并且能够审核并批准你的请求。 如果没有为任何用户分配 Exchange 管理员 角色,则具有 全局管理员 角色的用户将收到此电子邮件。

提交获得批准后,无论是自动批准还是由管理员批准,注册最多需要 24 小时才能生效。

对于我的组织注册,管理员帐户将收到一封电子邮件,并且提交者也将收到这些电子邮件。 如果你需要提供进一步的说明或详细信息,这可让你与管理员联系。 请求获得批准后,提交者和管理员将收到另一封电子邮件通知。

24 小时后,可以通过将可操作邮件从服务发送到邮箱或指定测试用户范围 () 的测试 用户 ,或者 组织范围内 ( 的任何用户邮箱) ,来验证注册是否已生效。 如果 24 小时已过且注册仍未生效,请使用注册仪表板标记为“注册不起作用?”顶部的反馈链接与我们联系。

测试用户电子邮件地址

此部分仅适用于要启用的可操作邮件的提交范围是“测试用户”的情况。

本节提供你组织中的 Microsoft 365 电子邮件用户的列表,以分号 (;) 分隔。 这将帮助你在创建“组织” 或“全局”范围提交之前,在几个用户中测试可操作的消息集成。

联系人信息

此部分仅适用于要启用的可操作邮件的提交范围是“全局”的情况。

在此部分中,需要提供联系人详细信息,以便我们对你的提交内容有其他疑问时可以与你联系。 提供的所有内容均必须准确有效。

发布程序信息

此部分仅适用于要启用的可操作邮件的提交范围是“全局”的情况。

在此部分中,需要提供要发送可操作邮件的服务的详细信息及相关的支持信息,以便我们可以与你联系或将客户转到你的支持网站。 此信息还将作为 Microsoft 对提供程序的审批处理的一部分。

场景详细信息

此部分仅适用于要启用的可操作邮件的提交范围是“全局”的情况。

在此部分中,需要提供用户将使用服务的可操作邮件的场景的详细信息及其他相关详细信息。 它旨在帮助 Microsoft 确定你的服务提供的解决方案的有效性和实用性。

验证详细信息

此部分仅适用于要启用的可操作邮件的提交范围是“全局”的情况。

在此部分中,需要向 Microsoft 提供用于验证可操作邮件及从提供程序/服务发送的电子邮件中调用的相应操作的详细信息。

此外,将来自生产服务器 (的有效电子邮件或具有类似 DKIM/SPF/From:/Return-Path: 标头) 包括标记的服务器发送到 onboardoam@microsoft.com。 此过程将使 Microsoft 能够确定解决方案是否符合注册条件中列出的所有准则和要求。

  • 发送此电子邮件前,请确保此标记正确无误。
  • 转发电子邮件时 Office 365 将删除所有标记。 请勿转发此电子邮件,请直接发送此邮件。

注册条件

将解决方案提交以进行“全局”范围审批时,需要注意一些事项,因为此解决方案可能对 Office 365 的用户产生广泛影响。

电子邮件发件人质量准则

  • 电子邮件必须经过 DKIM 或 SPF 身份验证。
  • SPF 检查或 DKIM 签名的一级域名 (TLD) 必须与 From: 电子邮件地址的 TLD 相匹配。 例如,如果你使用 From: myservice@contoso.com,则 DKIM 或 SPF 必须用于 contoso.com-.contoso.com
  • 电子邮件必须来自静态电子邮件地址,例如 myservice@contoso.com
  • 电子邮件必须遵循电子邮件发件人准则。
  • 至少持续数周从域发送大量邮件(每日最少向 Office 365 发送数百个电子邮件)的连续历史记录。
  • 用户的垃圾邮件投诉率极低。
  • 应使用高保真、简单的常规操作,以供服务使用。 对于更为复杂的交互,可使用 OpenURI 操作。
  • 应将操作用于预计交互频率较高的事务性邮件。 不应将其用于促销性批量邮件。

操作准则

  • 按钮标签必须反映要执行的明确操作。
  • Action.OpenUrl 操作必须深入链接到与可操作邮件中显示的实体/信息相关联的特定页面。
  • 服务处理操作请求的失败率低且响应快速。
  • 请参阅使用自适应卡片格式设计 Outlook 可操作邮件卡,获取有关设计可操作邮件的其他指导。

提交审批

我们将向你提交时提供的电子邮件地址发送通知,因此请确保你提供的联系信息准确无误。