Sdk a rozhraní REST API
Azure Communication Services jsou koncepčně uspořádané do osmi oblastí. Většina oblastí má plně open source sdk naprogramované na publikovaná rozhraní 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á jako zdroj.
V následujících tabulkách shrnujeme tyto oblasti a dostupnost rozhraní REST API a knihoven SDK. Všimněte si také, jestli jsou rozhraní API a sdk určené pro klienty koncových uživatelů nebo prostředí důvěryhodných služeb. Rozhraní API a sdk, jako je SMS, by neměla být přímo přístupná zařízením koncových uživatelů v prostředích s nízkou důvěryhodností.
Vývoj webových volajících a chatových aplikací je možné urychlit pomocí Azure Communication Services uživatelského rozhraní. Knihovna uživatelského rozhraní poskytuje komponenty uživatelského rozhraní připravené pro produkční prostředí, které můžete zapustit do svých aplikací.
Rozhraní REST API
Communication Services rozhraní API jsou zdokumentovaná společně s dalšími rozhraními Azure REST API v docs.microsoft.com. Tato dokumentace vám řekne, jak strukturovat zprávy HTTP, a nabídne pokyny pro používání nástroje Postman. Dokumentaci k rozhraní REST nabízíme také ve formátu Swagger na GitHub.
Sady SDK
| Sestavení | Protokoly | Prostředí | Možnosti |
|---|---|---|---|
| Azure Resource Manager | REST | Služba | Zřizování a správa Communication Services prostředků |
| Společné | – | Služba & klienta | Poskytuje základní typy pro jiné sdk. |
| Identita | REST | Služba | Správa uživatelů, přístupové tokeny |
| Telefon čísla | REST | Služba | Získání a správa telefonních čísel |
| SMS | REST | Služba | Odesílání a příjem zpráv SMS |
| Chat | REST s proprietárním signálem | Služba & klienta | Přidání textového chatu v reálném čase do aplikací |
| Volání | Proprietární přenos | Klient | Hlasová komunikace, video, sdílení obrazovky a další komunikace v reálném čase |
| Volající server | REST | Služba | Volání, přehrávání zvuku a konfigurace záznamu a správa volání |
| Network Traversal | REST | Služba | 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 chat a volání aplikací |
Jazyky a umístění publikování
Umístění publikování pro jednotlivé balíčky SDK jsou podrobně uvedená níže.
| Plošný | JavaScript | .NET | Python | Java SE | iOS | Android | Jiné |
|---|---|---|---|---|---|---|---|
| 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 | - | - | - |
| Telefon čísla | npm | NuGet | PyPi | Maven | - | - | - |
| Chat | npm | NuGet | PyPi | Maven | GitHub | Maven | - |
| SMS | npm | NuGet | PyPi | Maven | - | - | - |
| Videohovory | npm | NuGet | - | - | GitHub | Maven | - |
| Automatizace volání | NuGet | Maven | |||||
| Procházení sítě | npm | NuGet | PyPi | Maven | - | - | - |
| Knihovna uživatelského rozhraní | npm | - | - | - | - | - | GitHub, Storybook |
| Referenční dokumentace | doc | doc | - | doc | doc | doc | - |
Mapování mezi popisnými názvy sestavení a obory názvů je:
| Sestavení | Obory názvů |
|---|---|
| Azure Resource Manager | Azure. ResourceManager. Communication |
| Společné | Azure. Communication. Common |
| Identita | Azure. Communication. identity |
| Telefon čísla | Azure. Communication. PhoneNumbers |
| SMS | Azure. Communication. SMS |
| Chat | Azure. Communication. chat |
| Videohovory | Azure. Communication. Calling |
| Volající Server | Azure. Communication. CallingServer |
| Procházení sítě | Azure. Communication. NetworkTraversal |
| Knihovna uživatelského rozhraní | Azure. Communication. Calling |
Omezení REST API
Určitá rozhraní REST API a odpovídající metody sady SDK mají omezení, která byste měli mít na vědomí. Překročení těchto omezení způsobí aktivaci 429 - Too Many Requests chybové odpovědi. Tato omezení se dají zvýšit prostřednictvím žádosti na podporu Azure.
| rozhraní API | Omezení |
|---|---|
| Všechna vyhledávání rozhraní API pro plán telefonního čísla | 4 požadavky za den |
| Koupit plán telefonního čísla | 1 nákup měsíčně |
| Odeslat SMS | 200 požadavků za minutu |
Podrobnosti podpory platformy SDK
iOS a Android
- Služba Communications Services pro iOS sady SDK Target verze 13 + a Xcode 11 +.
- Android Java SDK cílové rozhraní Android API úrovně 21 + a Android Studio 4.0 +
.NET
S výjimkou volání, cílové balíčky služby Communications .NET Standard 2,0, které podporují platformy uvedené níže.
podpora prostřednictvím .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 +
- Více verzí/distribucí pro Linux
- 10.0.16299 UWP (RS3), září 2017
- Unity 2018,1
- Mono 5,4
- Xamarin iOS 10,14
- Xamarin Mac 3,8
volající balíček podporuje aplikace pro UWP sestavení pomocí .NET Native nebo C++/WinRT na:
- Windows 10 10.0.17763
- Windows Server 2019 10.0.17763
Očekávání stability rozhraní API
Důležité
V této části najdete pokyny pro rozhraní REST API a sady SDK s označením stabilní. Rozhraní API označená předběžná verze, verze Preview nebo beta můžou být beze změny nebo zastaralá.
V budoucnu můžeme vyřadit verze sad SDK pro komunikaci a můžeme začlenit zásadní změny našich rozhraní REST API a vydaných sad SDK. Komunikační služby Azure budou obecně splňovat dvě zásady podpory pro vyřazení verzí služby:
- Před změnou kódu z důvodu změny rozhraní komunikačních služeb budete upozorněni alespoň na tři roky. Všechna dokumentované rozhraní REST API a rozhraní API sady SDK obecně využívají před vyřazením rozhraní alespoň tři roky upozornění.
- Před aktualizací sestavení sady SDK na nejnovější podverzi budete upozorněni alespoň na jeden rok. Tyto požadované aktualizace by neměly vyžadovat změny kódu, protože jsou ve stejné hlavní verzi. Použití nejnovější sady SDK je zvlášť důležité pro volající a konverzační knihovny, které pracují s komponentami v reálném čase, které často vyžadují aktualizace zabezpečení a výkonu. Důrazně doporučujeme, abyste všechny sady SDK služby Communication Services aktualizovali.
Příklady vyřazení rozhraní API a sady SDK z provozu
V24i jste do své aplikace integraci verze REST API serveru SMS. Komunikační verze Azure v25.
Před tím, než tato rozhraní API přestanou fungovat a budou nuceně aktualizovat na V25, zobrazí se tři roky. Tato aktualizace může vyžadovat změnu kódu.
Do své aplikace jste zapnuli verzi v 2.02 volání sady SDK. Azure Communications releases v 2.05.
Do 12 měsíců od vydání verze v2.05 může být nutné aktualizovat na verzi v2.05 volající sady SDK. Mělo by jít o jednoduché nahrazení artefaktu bez nutnosti změny kódu, protože verze 2.05 je ve hlavní verzi v2 a nemá žádné zásadní změny.
Další kroky
Další informace najdete v následujících přehledech sady SDK:
Začínáme s Azure Communication Services: