SDKs und REST-APIs
Funktionen von Azure Communication Services sind konzeptionell basierend auf ihrem Funktionsbereich in diskreten Bereichen organisiert. Die meisten Bereichen weisen vollständig quelloffene SDKs auf, die gegen veröffentlichte REST-APIs programmiert sind, und die Sie direkt über das Internet nutzen können. Das Calling SDK verwendet proprietäre Netzwerkschnittstellen und ist Closed-Source.
In den folgenden Tabellen sind diese Bereiche und die Verfügbarkeit von REST-APIs und SDK-Bibliotheken zusammengefasst. Es wird jeweils darauf hingewiesen, ob APIs und SDKs für Endbenutzerclients oder vertrauenswürdige Dienstumgebungen bestimmt sind. Von Endbenutzergeräten darf in Umgebungen mit niedriger Vertrauenswürdigkeit nicht direkt auf APIs wie SMS zugegriffen werden.
Die Entwicklung von Anruf- und Chatanwendungen kann durch die UI-Bibliothek von Azure Communication Services beschleunigt werden. Die anpassbare UI-Bibliothek bietet Open-Source-Komponenten für die Benutzeroberfläche für Web- und mobile Apps sowie ein Microsoft Teams-Design.
SDKs
| Assembly | Protokolle | Environment | Capabilities |
|---|---|---|---|
| Azure Resource Manager | REST | Dienst | Dient zum Bereitstellen und Verwalten von Communication Services-Ressourcen |
| Allgemein | N/V | Client und Dienst | Stellt Basistypen für andere SDKs zur Verfügung |
| Identität | REST | Dienst | Verwalten von Benutzern, Zugriffstoken |
| Telefonnummern | REST | Dienst | Erfassen und Verwalten von Telefonnummern |
| SMS | REST | Dienst | Senden und Empfangen von SMS-Nachrichten |
| E‑Mail | REST | Dienst | Senden und Abrufen des Status von E-Mail-Nachrichten |
| Chat | REST mit proprietärer Signalisierung | Client und Dienst | Dient zum Hinzufügen von Textchat in Echtzeit zu Ihren Anwendungen |
| Calling | Proprietärer Transport | Client | Sprache, Video, Bildschirmfreigabe und andere Echtzeitkommunikation |
| Anrufautomatisierung | REST | Dienst | Erstellen angepasster Anrufworkflows für PSTN- und VoIP-Anrufe |
| Auftragsrouter | REST | Dienst | Optimieren der Verwaltung von Kundeninteraktionen über verschiedene Anwendungen hinweg |
| Network Traversal | REST | Dienst | Zugreifen auf TURN-Server für Datentransporte auf niedriger Ebene |
| Räume | REST | Dienst | Erstellen und Verwalten strukturierter Kommunikationsräume |
| UI-Bibliothek | N/V | Client | Produktionsbereite UI-Komponenten für Chat- und Anruf-Apps |
Sprachen und Veröffentlichungsspeicherorte
Die Veröffentlichungsstandorte für die einzelnen SDK-Pakete sind unten aufgeführt.
| Bereich | JavaScript | .NET | Python | Java SE | iOS | Android | Andere |
|---|---|---|---|---|---|---|---|
| Azure Resource Manager | npm | NuGet | PyPi | Maven | - | - | Go über GitHub |
| Allgemein | npm | NuGet | N/V | Maven | GitHub | Maven | - |
| Identität | npm | NuGet | PyPi | Maven | - | - | - |
| Telefonnummern | npm | NuGet | PyPi | Maven | - | - | - |
| Chat | npm | NuGet | PyPi | Maven | GitHub | Maven | - |
| SMS | npm | NuGet | PyPi | Maven | - | - | - |
| E‑Mail | npm | NuGet | PyPi | Maven | - | - | - |
| Aufrufen | npm | NuGet | - | - | CocoaPods | Maven | - |
| Anrufautomatisierung | npm | NuGet | PyPi | Maven | |||
| Auftragsrouter | npm | NuGet | PyPi | Maven | |||
| Network Traversal | npm | NuGet | PyPi | Maven | - | - | - |
| Räume | npm | NuGet | PyPi | Maven | - | - | - |
| UI-Bibliothek | npm | - | - | - | GitHub | GitHub | GitHub, Storybook |
| Erweitertes Messaging | - | NuGet | - | - | - | - | - |
| Referenzdokumentation | docs | docs | docs | docs | docs | docs | - |
Details zur SDK-Plattformunterstützung
Android Calling SDK-Unterstützung
- Unterstützung für Android-API Level 21 oder höher
- Unterstützung für Java 7 oder höher
- Unterstützung für Android Studio 2.0
- Android Auto (AAOS) und IoT-Geräte mit Android werden derzeit nicht unterstützt.
iOS Calling SDK-Unterstützung
- Unterstützung für iOS 10.0 und höher zur Erstellungszeit und iOS 12.0 und höher zur Laufzeit
- Xcode 12.0 oder höher
- Unterstützung für iPadOS 13.0+
.NET
Anrufe unterstützen die unten aufgeführten Plattformen.
- UWP mit .NET Native oder C++/WinRT
- Windows 10/11 10.0.17763 – 10.0.22621.0
- Windows Server 2019/2022 10.0.17763 - 10.0.22621.0
- WinUI3 mit .NET 6
- Windows 10/11 10.0.17763.0 - net6.0-windows10.0.22621.0
- Windows Server 2019/2022 10.0.17763.0 - net6.0-windows10.0.22621.0
Alle anderen Communication Services-Pakete zielen ab auf den .NET-Standard 2.0, der die unten aufgeführten Plattformen unterstützt.
- Unterstützung über .NET Framework 4.6.1
- Windows 10, 8.1, 8 und 7
- Windows Server 2012 R2, 2012 und 2008 R2 SP1
- Unterstützung über .NET Core 2.0:
- Windows 10 (ab 1607), 7 SP1+, 8.1
- Windows Server 2008 R2 SP1+
- Mac OS X ab 10.12
- Mehrere Versionen/Distributionen von Linux
- UWP 10.0.16299 (RS3) September 2017
- Unity 2018.1
- Mono 5.4
- Xamarin iOS 10.14
- Xamarin Mac 3.8
REST-APIs
Communication Services-APIs sind neben anderen Azure-REST-APIs dokumentiert. In dieser Dokumentation wird die Strukturierung von HTTP-Nachrichten erläutert. Zudem enthält sie eine Anleitung zur Verwendung von Postman. Die Dokumentation zur REST-Schnittstelle wurde auch im Swagger-Format auf GitHub veröffentlicht. Sie finden Drosselungseinschränkungen für einzelne APIs auf der Seite „Diensteinschränkungen“.
Erwartungen an die API-Stabilität
Wichtig
Dieser Abschnitt enthält Anleitungen zu REST-APIs und SDKs, die als stabil gekennzeichnet sind. APIs, die als Vorabversion, Vorschau oder Beta gekennzeichnet sind, können ohne Vorankündigung geändert oder als veraltet eingestuft werden.
In der Zukunft werden wir möglicherweise Versionen der SDKs für Kommunikationsdienste außer Betrieb nehmen, und wir könnten bahnbrechende Veränderungen an unseren REST-APIs und veröffentlichten SDKs vornehmen. Für Azure Communication Services gelten allgemein zwei Richtlinien zur Unterstützung des Zurückziehens von Dienstversionen:
- Sie werden mindestens drei Jahre vorher benachrichtigt, ehe Sie aufgrund einer Änderung einer Communication Services-Schnittstelle Code ändern müssen. Bei allen dokumentierten REST-APIs und SDK-APIs wird in der Regel eine mindestens dreijährige Vorwarnzeit eingehalten, bevor Schnittstellen ausgemustert werden.
- Sie werden mindestens ein Jahr, bevor Sie SDK-Assemblies auf die neueste Minor-Version aktualisieren müssen, benachrichtigt. Diese erforderlichen Aktualisierungen sollten keine Codeänderungen erfordern, da sie zur gleichen Hauptversion gehören. Die Verwendung des neuesten SDK ist besonders wichtig für die Bibliotheken „Calling“ und „Chat“, die über Echtzeitkomponenten verfügen, bei denen häufig Sicherheits- und Leistungsaktualisierungen erforderlich sind. Wir empfehlen Ihnen nachdrücklich, sämtliche Ihrer Communication Services-SDKs auf dem neuesten Stand zu halten.
Beispiele für die Außerbetriebnahme von API und SDK
Sie haben Version 24 der REST-API „SMS“ in Ihre Anwendung integriert. Azure Communication veröffentlicht Version 25.
Sie erhalten eine dreijährige Vorwarnung, bevor diese APIs nicht mehr funktionieren und Sie gezwungen sind, auf v25 zu aktualisieren. Dieses Update erfordert möglicherweise eine Codeänderung.
Sie haben die Version 2.02 vom Calling-SDK in Ihre Anwendung integriert. Azure Communication veröffentlicht Version 2.05.
Es kann erforderlich sein, dass Sie innerhalb von 12 Monaten nach der Freigabe des v2.05 auf die Version v2.05 des Calling SDK aktualisieren müssen. Dabei sollte es sich um einen einfachen Austausch des Artefakts handeln, ohne dass eine Codeänderung erforderlich ist, da Version 2.05 zur Hauptversion 2 gehört und keine Breaking Changes aufweist.
Nächste Schritte
Weitere Informationen finden Sie in den folgenden SDK-Übersichten:
- Calling SDK Übersicht
- Übersicht über das Anrufautomatisierungs-SDK
- Übersicht über das Job Router SDK
- Chat SDK Übersicht
- SMS SDK Übersicht
- Übersicht über das Email SDK
Für den Einstieg in Azure Communication Services: