Registrieren Ihres Diensts beim Entwicklerdashboard für Nachrichten mit Aktionen

  • Artikel

Wichtig

Das Onboarding von neuen Anbietern für aktionenfähige Nachrichten im Global-Bereich wird aufgrund von Dienstupgrades vorübergehend bis zum 30. Juni 2024 angehalten. Vorhandene globale Anbieter und das Onboarding von Organisations- und Testbereichsanbietern sind nicht betroffen. Weitere Informationen finden Sie unter Häufig gestellte Fragen zu Aktionen erfordernden Nachrichten.

Um Nachrichten mit Aktionen von Ihrem Dienst zu testen und zu veröffentlichen, müssen Sie bestimmte Informationen an Microsoft weitergeben, um diese Funktionalität für E-Mails von Ihrem Dienst zu aktivieren. Mit dem Entwicklerdashboard können Sie den Status Ihrer Übermittlung über das Webportal übermitteln und verfolgen.

Hinweis

Sie können Nachrichten mit Aktionen ganz einfach per E-Mail ausprobieren, indem Sie E-Mails mit dem erforderlichen Markup ohne Eingreifen von Microsoft an sich selbst senden. Dies wäre in der Regel der erste Schritt, den Sie im Zusammenhang mit dieser Funktion ausprobieren. Sehen Sie sich diese Beispiele an, um eine Nachricht mit Aktionen an Ihr Postfach zu senden, oder verwenden Sie die aktionsfähige Nachricht Designer, um eine Nachricht mit Aktionen an sich selbst zu senden.

Wenn Sie ein Entwickler sind und mit Nachrichten mit Aktionen per E-Mail arbeiten, verwenden Sie das Portal für die folgenden Fälle:

  • Zum Testen von Nachrichten mit Aktionen von Ihrem Dienst an Ihr eigenes Postfach
  • Zum Veröffentlichen von Nachrichten mit Aktionen von Ihrem Dienst, damit jeder E-Mail-Benutzer innerhalb Ihrer Organisation, der Office 365 verwendet, diese speziell formatierten Nachrichten empfangen kann (dies wird in der Regel zum Aktivieren von Nachrichten mit Aktionen von einem Dienst verwendet, der für Ihre Organisation spezifisch ist, z. B. eine Branchen-App)
  • Zum Veröffentlichen von Nachrichten mit Aktionen von Ihrem Dienst, damit jeder E-Mail-Benutzer in Office 365, der Ihren Dienst verwendet, diese speziell formatierten Nachrichten empfangen kann

Für die oben genannten Fälle übermitteln Sie bestimmte Details an Microsoft, die, nach Prüfung und Genehmigung, Nachrichten mit Aktionen für Ihren Dienst aktivieren.

Dashboardbereiche

Das Entwicklerdashboard ist in ein paar logische Bereiche unterteilt, die Sie basierend auf dem Umfang angeben müssen, den Sie von Microsoft anfordern möchten, um Nachrichten mit Aktionen von Ihrem Dienst zu aktivieren.

Details zu Ihrem Anbieter

In diesem Bereich müssen Sie wichtige Informationen angeben, mit denen Office 365 E-Mail mit Markup von Ihrem Dienst sowie URLs akzeptieren kann, die über die Aktionsschaltflächen in diesen E-Mail aufgerufen werden können.

Die wichtigsten Felder sind:

  • E-Mail-Adresse des Absenders: Hierbei handelt es sich um eine oder mehrere statische E-Mail-Adressen, die dem Dienst entsprechen, der E-Mails mit Aktions-Markup sendet. Beispiel: myservice@contoso.com.

  • Ziel-URLs: Dies ist eine oder mehrere Domänen, die URLs entsprechen, die die Aktionen verarbeiten. Ihre Ziel-URL kann der Domäne der obersten Ebene oder der Unterdomäne der TLD entsprechen. Es muss sich um https-fähige URLs handeln. Beispiel. https://api.myservice.com.

  • Öffentlicher Schlüssel: Wenn Sie Aktionen erfordernde Nachrichten als signierte Karte senden möchten, müssen Sie den öffentlichen Schlüssel angeben, der dem privaten Schlüssel entspricht, den Sie zum Signieren der Karte verwenden. Das Format für dieses Feld ist ein RSAKeyValue-Element.

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

Ein RSA-Schlüsselpaar kann mit PowerShell (7.3 oder höher) im richtigen Format generiert und exportiert werden:

# 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)

Ein Beispiel zum Abrufen von XML mit öffentlichem Schlüssel aus einer CERT-Datei finden Sie unter PublicKey-Klasse.

Hinweis

Nachdem Ihre Übermittlung genehmigt wurde, kann es einige Zeit dauern, bis sie wirksam wird. Wenn beim Senden signierter Karten der folgende Fehler auftritt und Sie sicher sind, dass Ihre Nutzlast korrekt ist, versuchen Sie es nach einigen Stunden erneut.

Adaptive card signature validation failed - Failed to validate signature

Umfang Ihrer Übermittlung

In diesem Bereich müssen Sie angeben, in welchem Umfang Sie Nachrichten mit Aktionen für Ihren Dienst aktivieren möchten. Die anwendbaren Bereiche sind:

  • Testbenutzer: Dadurch werden Nachrichten mit Aktionen von Ihrem Dienst für einige O365-E-Mail-Benutzer Ihrer Organisation aktiviert. Dieser Bereich wird im Allgemeinen zum Testen der Integration von Nachrichten mit Aktionen mit wenigen Testbenutzern verwendet, die Sie angegeben haben.
  • Organisation: Dies ermöglicht eine Nachricht mit Aktionen von Ihrem Dienst an jeden Microsoft 365-E-Mail-Benutzer in Ihrer Organisation. Dieser Umfang wird in der Regel zum Aktivieren von Nachrichten mit Aktionen von einem Dienst verwendet, der für Ihre Organisation spezifisch ist, z. B. eine interne Branchenanwendung in Ihrer Organisation.
  • Global: Dadurch werden Nachrichten mit Aktionen von Ihrem Dienst für einen beliebigen E-Mail-Benutzer in Office 365 aktiviert.

Jeder der oben genannten Schritte ist unabhängig. Sie können also nur einen Bereich für jede Übermittlung auswählen und unterliegt dem Genehmigungsprozess durch Microsoft.

Hinweis

Denken Sie daran, dass Sie nachrichten mit Aktionen ganz einfach ausprobieren können, indem Sie eine E-Mail mit dem erforderlichen Markup ohne Eingreifen von Microsoft an sich selbst senden. Sie können die aktionsfähige Nachricht Designer verwenden, um an sich selbst zu senden, ohne Code zu schreiben. Dies ist normalerweise der erste Schritt beim Testen von Nachrichten mit Aktionen.

Self-Service-Registrierung

Self-Service-Registrierungen sind für Registrierungen verfügbar, die die folgenden Umfänge verwenden.

  • Testbenutzer: Die Registrierungsanforderung wird für die angegebenen Testbenutzer automatisch genehmigt. Dadurch werden Nachrichten mit Aktionen von Ihrem Dienst aktiviert, die an Ihre Testbenutzer gesendet werden.
  • Organisation: Diese Registrierungsanforderung wird an die Administratoren Ihrer Organisation mit den Berechtigungen Exchange-Administrator gesendet. Jeder Administrator mit diesen Berechtigungen erhält eine E-Mail mit Übermittlungsdetails und kann Ihre Anforderung überprüfen und genehmigen. Wenn keine Benutzer die Rolle Exchange-Administrator zugewiesen haben, werden Benutzer mit der Rolle Globaler Administrator stattdessen diese E-Mail erhalten.

Nachdem die Übermittlung genehmigt wurde , ob automatisch genehmigt oder von Ihrem Administrator, dauert es bis zu 24 Stunden, bis die Registrierung wirksam wird.

Für Registrierungen mit dem Umfang Meine Organisation erhalten die Administratorkonten eine E-Mail, und der Übermittler erhält ebenfalls eine Kopie dieser E-Mails. Auf diese Weise können Sie sich an Ihren Administrator wenden, wenn Sie weitere Erklärungen oder Details bereitstellen möchten. Nachdem die Anforderung genehmigt wurde, werden der Übermittler und die Administratoren mit einer weiteren E-Mail benachrichtigt.

Nach Ablauf von 24 Stunden können Sie überprüfen, ob die Registrierung wirksam wurde, indem Sie eine Nachricht mit Aktionen von Ihrem Dienst an Ihr Postfach oder bestimmte Testbenutzer (für den Bereich "Testbenutzer") oder ein beliebiges Benutzerpostfach in Ihrem organization (für den Organisationsbereich) senden. Wenn 24 Stunden vergangen sind und die Registrierung immer noch nicht wirksam ist, kontaktieren Sie uns bitte über den Feedback-Link oben Dashboard Registrierung funktioniert nicht?.

E-Mail-Adressen der Testbenutzer

Dieser Bereich trifft nur zu, wenn der Umfang der Übermittlung zum Aktivieren von Nachrichten mit Aktionen Testbenutzer lautet.

In diesem Abschnitt finden Sie eine Liste der Microsoft 365-E-Mail-Benutzer Ihrer Organisation, die durch ein Semikolon (;) abgetrennt sind. Auf diese Weise können Sie die Integration von Nachrichten mit Aktionen bei einigen wenigen Benutzern testen, bevor Sie eine Organisation oder globale Bereichsübermittlung erstellen.

Kontaktinformationen

Dieser Bereich trifft nur zu, wenn der Umfang der Übermittlung zum Aktivieren von Nachrichten mit Aktionen Global lautet.

In diesem Bereich müssen Sie Kontaktdetails angeben, damit wir uns an Sie wenden können, wenn wir weitere Fragen zu Ihrer Übermittlung haben. Alle Angaben müssen gültig und korrekt sein.

Herausgeberinformationen

Dieser Bereich trifft nur zu, wenn der Umfang der Übermittlung zum Aktivieren von Nachrichten mit Aktionen Global lautet.

In diesem Bereich müssen Sie Informationen zu Ihrem Dienst angeben, der Nachrichten mit Aktionen und damit im Zusammenhang stehende Supportinformationen senden wird, damit wir uns an Sie wenden oder Kunden zu Ihrer Supportwebsite weiterleiten können. Diese Informationen werden auch im Rahmen des Genehmigungsprozesses von Microsoft für Ihren Anbieter verwendet.

Szenarioinformationen

Dieser Bereich trifft nur zu, wenn der Umfang der Übermittlung zum Aktivieren von Nachrichten mit Aktionen Global lautet.

In diesem Bereich müssen Sie Informationen zum Szenario, für das Benutzer Nachrichten mit Aktionen von Ihrem Dienst verwenden werden, sowie andere relevante Informationen angeben. Dies soll Microsoft helfen, die Gültigkeit und Nützlichkeit der von Ihrem Dienst bereitgestellten Lösung zu bestimmen.

Überprüfungsinformationen

Dieser Bereich trifft nur zu, wenn der Umfang der Übermittlung zum Aktivieren von Nachrichten mit Aktionen Global lautet.

In diesem Bereich müssen Sie Details für Microsoft zum Überprüfen der Nachrichten mit Aktionen und der entsprechenden Aktionen angeben, die von der an Ihren Anbieter/Dienst gesendeten E-Mail aufgerufen werden.

Senden Sie außerdem eine gültige E-Mail von Ihren Produktionsservern (oder einem Server mit ähnlichen DKIM/SPF/From:/Return-Path: Headern), einschließlich des Markups an onboardoam@microsoft.com. Mit diesem Verfahren kann Microsoft feststellen, dass die Lösung alle unter Registrierungskriterien aufgeführten Richtlinien und Anforderungen erfüllt.

  • Stellen Sie vor dem Senden der Nachricht sicher, dass das Markup korrekt ist.
  • Office 365 entfernt das gesamte Markup beim Weiterleiten einer E-Mail-Nachricht. Leiten Sie keine E-Mails weiter, sondern senden Sie sie direkt.

Registrierungskriterien

Es gibt einige Dinge, die Sie beachten müssen, wenn Sie Ihre Lösung zur Genehmigung für den UmfangGlobal übermitteln, da dies wesentliche Auswirkungen auf Benutzer in Office 365 haben kann.

Qualitätsrichtlinien für E-Mail-Absender

  • E-Mail-Nachrichten müssen über DKIM oder SPF authentifiziert werden.
  • Die Domäne die obersten Ebene (TLD) der SPF-Prüfung oder die DKIM-Signatur muss der TLD Ihrer From:-E-Mail-Adresse entsprechen. Wenn Sie beispielsweise From: myservice@contoso.com verwenden, muss die DKIM oder SPF für contoso.com oder -.contoso.com sein.
  • E-Mails müssen von einer statischen E-Mail Adresse stammen, z. B. myservice@contoso.com.
  • E-Mails müssen den Richtlinien für E-Mail-Absender entsprechen.
  • Konsistenter Verlauf des Sendens eines großen E-Mail-Volumens von Ihrer Domäne (in der Größenordnung von mindestens hundert E-Mails pro Tag an Office 365) für mindestens ein paar Wochen.
  • Eine sehr niedrige Rate von Spambeschwerden von Benutzern.
  • Es sollten sehr präzise, routinemäßige und einfache Aktionen, die für Ihren Dienst verfügbar sind, verwendet werden. Für komplexere Interaktionen können OpenURI-Aktionen verwendet werden.
  • Aktionen sollten für Transaktions-E-Mails verwendet werden, bei denen eine hohe Interaktionsrate erwartet wird. Sie sollten nicht für Massen-E-Mails zu Werbezwecken verwendet werden.

Aktionsrichtlinien

  • Die Bezeichnung der Schaltfläche muss klar die Aktion darstellen, die ausgeführt werden soll.
  • Die Action.OpenUrl-Aktion muss als Deep-Link für die jeweilige Seite fungieren, die der in der Nachricht mit Aktionen dargestellten Entität/Information zugeordnet ist.
  • Niedrige Fehlerrate und schnelle Reaktion für Dienste, die Aktionsanforderungen verarbeiten.
  • Weitere Richtlinien zum Design von Nachrichten mit Aktionen finden Sie unter Entwerfen von Outlook-Nachrichtenkarten mit Aktionen mittels adaptivem Kartenformat.

Genehmigung Ihrer Übermittlung

Sie erhalten eine Benachrichtigung an die E-Mail-Adresse, die Sie bei der Übermittlung angegeben haben, stellen Sie daher sicher, dass Sie die korrekten Kontaktinformationen angeben.