Sady SDK a rozhraní REST API

Funkce Azure Communication Services jsou koncepčně uspořádané do samostatných oblastí na základě jejich funkční oblasti. Většina oblastí má plně opensourcové sady SDK naprogramované proti publikovaným rozhraním REST API, která můžete používat přímo přes internet. Volající sada SDK používá proprietární síťová rozhraní a je uzavřená.

V následujících tabulkách shrnujeme tyto oblasti a dostupnost rozhraní REST API a knihoven SDK. Upozorňujeme, že rozhraní API a sady SDK jsou určená pro klienty koncových uživatelů nebo důvěryhodná prostředí služeb. Rozhraní API, jako je NAPŘÍKLAD SMS, by neměla být přímo přístupná zařízeními koncových uživatelů v prostředích s nízkou důvěryhodností.

Vývoj aplikací pro volání a chat je možné urychlit knihovnou uživatelského rozhraní služeb Azure Communication Services. Přizpůsobitelná knihovna uživatelského rozhraní poskytuje opensourcové komponenty uživatelského rozhraní pro webové a mobilní aplikace a motiv Microsoft Teams.

Sady SDK

Sestavení Protokoly Prostředí Funkce
Azure Resource Manager REST Service Zřizování a správa prostředků komunikačních služeb
Společné Klientská & služba Poskytuje základní typy pro jiné sady SDK.
Identita REST Service Správa uživatelů, přístupových tokenů
Telefonní čísla REST Service Získání a správa telefonních čísel
SMS REST Service Odesílání a příjem zpráv SMS
E-mail REST Service Odesílání a získávání stavu u e-mailových zpráv
Chat REST s proprietárním signálem Klientská & služba Přidání textového chatu v reálném čase do aplikací
Volání Proprietární doprava Klient Hlas, video, sdílení obrazovky a další komunikace v reálném čase
Automatizace volání REST Service Vytváření přizpůsobených pracovních postupů volání pro volání do veřejné telefonní sítě a volání VoIP
Směrovač úloh REST Service Optimalizace správy interakcí zákazníků napříč různými aplikacemi
Procházení sítě REST Service Přístup k serverům TURN pro přenos dat nízké úrovně
Knihovna uživatelského rozhraní Klient Komponenty uživatelského rozhraní připravené pro produkční prostředí pro chatovací a volací aplikace

Jazyky a umístění publikování

Umístění publikování pro jednotlivé balíčky SDK jsou podrobně popsána níže.

Plocha JavaScript .NET Python Java SE iOS Android Jiný důvod
Azure Resource Manager npm NuGet PyPi Maven - - Přejít přes GitHub
Společné npm NuGet Maven GitHub Maven -
Identita npm NuGet PyPi Maven - - -
Telefonní čísla npm NuGet PyPi Maven - - -
Chat npm NuGet PyPi Maven GitHub Maven -
SMS npm NuGet PyPi Maven - - -
E-mail npm NuGet PyPi Maven - - -
Volání npm NuGet - - GitHub Maven -
Automatizace volání npm NuGet PyPi Maven
Směrovač úloh npm NuGet PyPi Maven
Procházení sítě npm NuGet PyPi Maven - - -
Knihovna uživatelského rozhraní npm - - - GitHub GitHub GitHub, Storybook
Referenční dokumentace dokumentace dokumentace - dokumentace dokumentace dokumentace -

Podrobnosti o podpoře platformy SDK

iOS a Android

  • Sady SDK služby Communication Services pro iOS cílí na iOS verze 13 nebo novější a Xcode 11+.
  • Sady Android Java SDK cílí na rozhraní Android API úrovně 21 nebo novější a Android Studio 4.0 nebo novější.

.NET

Volání podporuje níže uvedené platformy.

  • UPW s .NET Native nebo C++/WinRT
    • Windows 10/11 10.0.17763 – 10.0.22621.0
    • Windows Server 2019/2022 10.0.17763 – 10.0.22621.0
  • WinUI3 s .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

Všechny ostatní balíčky komunikačních služeb cílí na .NET Standard 2.0, které podporují níže uvedené platformy.

  • Podpora prostřednictvím rozhraní .NET Framework 4.6.1
    • Windows 10, 8.1, 8 a 7
    • Windows Server 2012 R2, 2012 a 2008 R2 SP1
  • Podpora prostřednictvím .NET Core 2.0:
    • Windows 10 (1607+), 7 SP1+, 8.1
    • Windows Server 2008 R2 SP1+
    • Max OS X 10.12+
    • Linux s více verzemi a distribucemi
    • UPW 10.0.16299 (RS3) září 2017
    • Unity 2018.1
    • Mono 5.4
    • Xamarin iOS 10.14
    • Xamarin Mac 3.8

Rozhraní REST API

Rozhraní API komunikačních služeb jsou zdokumentovaná společně s dalšími rozhraními AZURE REST API. Tato dokumentace vám řekne, jak strukturovat zprávy HTTP a nabízí pokyny k používání nástroje Postman. Dokumentace k rozhraní REST je také publikovaná ve formátu Swagger na GitHubu. Omezení omezení pro jednotlivá rozhraní API najdete na stránce omezení služeb.

Očekávání stability rozhraní API

Důležité

Tato část obsahuje pokyny k rozhraním REST API a sadám SDK označeným jako stabilní. Rozhraní API označená jako předběžná verze, verze Preview nebo beta verze se můžou změnit nebo přestat používat bez předchozího upozornění.

V budoucnu můžeme vyřadit verze sad SDK komunikačních služeb a můžeme zavést zásadní změny našich rozhraní REST API a vydaných sad SDK. Služba Azure Communication Services bude obecně dodržovat dvě zásady podpory pro vyřazení verzí služby:

  • Budete upozorněni alespoň tři roky, než budete muset změnit kód kvůli změně rozhraní komunikačních služeb. Všechna zdokumentovaná rozhraní REST API a rozhraní API sady SDK mají obecně alespoň tři roky upozornění před vyřazením rozhraní z provozu.
  • Než budete muset aktualizovat sestavení SADY SDK na nejnovější podverzi, budete upozorněni alespoň jeden rok. Tyto požadované aktualizace by neměly vyžadovat žádné změny kódu, protože jsou ve stejné hlavní verzi. Použití nejnovější sady SDK je zvlášť důležité pro knihovny volání a chatu, které často vyžadují aktualizace zabezpečení a výkonu v reálném čase. Důrazně doporučujeme udržovat všechny sady SDK komunikačních služeb aktualizované.

Příklady vyřazení rozhraní API a sady SDK z provozu

Do aplikace jste integrovali verzi rozhraní REST API sms v24. Verze Azure Communication v25.

Než tato rozhraní API přestanou fungovat, dostanete upozornění na tři roky a budou nuceni provést aktualizaci na verzi 25. Tato aktualizace může vyžadovat změnu kódu.

Do aplikace jste integrovali verzi sady SDK volání verze 2.02. Verze Azure Communication v2.05

Do 12 měsíců od vydání verze 2.05 se může vyžadovat aktualizace na verzi v2.05 sady SDK pro volání. Toto by mělo být jednoduché nahrazení artefaktu bez nutnosti změny kódu, protože verze 2.05 je ve hlavní verzi v2 a neobsahuje žádné zásadní změny.

Další kroky

Další informace najdete v následujících přehledech sady SDK:

Začínáme se službou Azure Communication Services: