Udostępnij za pośrednictwem

Zestawy SDK i interfejsy API REST

Możliwości usług Azure Communication Services są koncepcyjnie zorganizowane w odrębne obszary na podstawie ich obszaru funkcjonalnego. Większość obszarów ma w pełni zestawy SDK typu open source zaprogramowane względem opublikowanych interfejsów API REST, których można używać bezpośrednio przez Internet. SDK do wywołań używa zastrzeżonych interfejsów sieciowych i jest zamknięty.

W poniższych tabelach podsumowano te obszary i dostępność interfejsów API REST i bibliotek zestawu SDK. Zauważamy, czy interfejsy API i zestawy SDK są przeznaczone dla klientów użytkowników końcowych, czy zaufanych środowisk usług. Nie należy uzyskiwać bezpośredniego dostępu do interfejsów API, takich jak sms, przy użyciu urządzeń użytkowników końcowych w środowiskach o niskim zaufaniu.

Możesz przyspieszyć tworzenie aplikacji do połączeń i czatów, korzystając z biblioteki interfejsu użytkownika Azure Communication Services. Dostosowywalna biblioteka interfejsu użytkownika udostępnia składniki interfejsu użytkownika typu open source dla aplikacji internetowych i mobilnych oraz motyw usługi Microsoft Teams.

Tworzenie rozwiązania do korzystania z najnowszego zestawu SDK

Przeglądarki i systemy operacyjne stale ewoluują, aby obsługiwać najnowsze ulepszenia i naprawiać istniejące błędy. Użycie najnowszego zestawu SDK usług Azure Communication Services może pomóc w osiągnięciu najlepszego ogólnego środowiska użytkownika końcowego aplikacji w przypadku używania z zaktualizowanymi przeglądarkami i aktualizacjami systemu operacyjnego. Większość aktualizacji zestawu SDK usług Azure Communication Services oferuje wiele korzyści, takich jak lepsza wydajność, bezpieczeństwo, zgodność, jakość i użyteczność. Aktualizacja umożliwia dostęp do najnowszych funkcji i aktualizacji, które są regularnie dodawane do przeglądarki i systemu operacyjnego. Zestawy SDK usług Azure Communication Services są często aktualizowane (co około sześć tygodni do raz na kwartał). Zalecamy utworzenie procesu, aby upewnić się, że zawsze aktualizujesz do najnowszych zestawów SDK.

SDK

Assembly Protokoły Środowisko Możliwości
Azure Resource Manager REST Usługa Zapewniaj i zarządzaj zasobami usług komunikacyjnych.
Common N/A Klient i usługa Udostępnia typy podstawowe dla innych zestawów SDK.
Tożsamość REST Usługa Zarządzanie użytkownikami i tokenami dostępu.
Numery telefonów REST Usługa Uzyskiwanie numerów telefonów i zarządzanie nimi.
SMS REST Usługa Wysyłanie i odbieranie wiadomości SMS.
Email REST Usługa Wysyłanie i uzyskiwanie stanu wiadomości e-mail.
Chat REST z zastrzeżoną sygnalizacją Klient i usługa Dodaj czat tekstowy w czasie rzeczywistym do aplikacji.
Calling Transport własnościowy Klient Komunikacja głosowa, wideo, udostępnianie ekranu i inna komunikacja w czasie rzeczywistym.
Automatyzacja wywołań REST Usługa Twórz dostosowane przepływy wywołań dla połączeń PSTN i VoIP.
Router zadań REST Usługa Optymalizowanie zarządzania interakcjami klientów w różnych aplikacjach.
Pokoje REST Usługa Tworzenie pomieszczeń komunikacyjnych ze strukturą i zarządzanie nimi.
Biblioteka interfejsu użytkownika N/A Klient Składniki interfejsu użytkownika gotowe do użycia produkcyjnego w aplikacjach do czatu i połączeń.
Zaawansowane komunikaty REST Usługa Wysyłaj i odbieraj wiadomości WhatsApp Business.

Języki i lokalizacje publikowania

Miejsca publikacji dla poszczególnych pakietów SDK.

Area JavaScript .NET Python Java SE iOS Android Other
Azure Resource Manager npm NuGet PyPi Maven - - Przejdź za pośrednictwem usługi GitHub
Common npm NuGet N/A Maven GitHub Maven -
Tożsamość npm NuGet PyPi Maven - - -
Numery telefonów npm NuGet PyPi Maven - - -
Chat npm NuGet PyPi Maven GitHub Maven -
SMS npm NuGet PyPi Maven - - -
Email npm NuGet PyPi Maven - - -
Calling npm NuGet - - CocoaPods Maven -
Automatyzacja wywołań npm NuGet PyPi Maven
Router zadań npm NuGet PyPi Maven
Pokoje npm NuGet PyPi Maven - - -
Biblioteka interfejsu użytkownika npm - - - GitHub GitHub GitHub, Storybook
Zaawansowane komunikaty npm NuGet PyPi Maven - - -
Dokumentacja referencyjna docs docs docs docs docs docs -

Szczegóły obsługi platformy SDK

Obsługa Android Calling SDK

  • Support for Android API Level 21 or Higher
  • Obsługa języka Java 7 lub nowszego
  • Obsługa programu Android Studio 2.0
Obsługa platformy systemu Android

Ekosystem systemu Android jest rozbudowany, obejmujący różne wersje i wyspecjalizowane platformy przeznaczone dla różnych typów urządzeń. W następnej tabeli wymieniono obecnie obsługiwane platformy systemu Android:

Urządzenia Description Wsparcie
Telefony i tablety Standardowe urządzenia z systemem Android Commercial. Pełne wsparcie dla rozdzielczości wideo.

Uwaga

Obsługujemy tylko połączenia wideo na telefonach i tabletach. W przypadku przypadków użycia obejmujących wideo na niezgodnych urządzeniach lub platformach (takich jak inteligentne okulary lub urządzenia niestandardowe), zalecamy skontaktowanie się z nami na wczesnym etapie procesu programowania, aby ułatwić określenie najbardziej odpowiedniego podejścia do integracji.

Jeśli podczas implementacji znaleziono problemy, zapoznaj się z przewodnikiem rozwiązywania problemów.

Obsługa SDK dla dzwonienia na iOS

  • Obsługa systemu iOS 10.0 lub nowszego w czasie kompilacji oraz systemu iOS 12.0+ w czasie wykonywania
  • Xcode 12.0+
  • Obsługa systemu iPadOS 13.0 lub nowszego

.NET

Calling supports the following platforms:

  • UWP z .NET Native lub C++/WinRT
    • Windows 10/11 10.0.17763 - 10.0.22621.0
    • Windows Server 2019/2022 10.0.17763 - 10.0.22621.0
  • WinUI3 z platformą .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

Wszystkie inne pakiety usług komunikacyjnych są przeznaczone dla platformy .NET Standard 2.0, która obsługuje następujące platformy:

  • Obsługa za pośrednictwem programu .NET Framework 4.6.1
    • Windows 10, 8.1, 8 i 7
    • Windows Server 2012 R2, 2012 i 2008 R2 SP1
  • Obsługa za pośrednictwem platformy .NET Core 2.0:
    • Windows 10 (1607+), 7 z dodatkiem SP1+, 8.1
    • Windows Server 2008 R2 SP1+
    • Max OS X 10.12+
    • Wiele wersji/dystrybucji systemu Linux
    • UWP 10.0.16299 (RS3) Wrzesień 2017
    • Unity 2018.1
    • Mono 5.4
    • Xamarin iOS 10.14
    • Xamarin Mac 3.8

Uwaga

Unpackaged app is currently not supported

Rozmiar pakietu zestawu SDK

SDK Rozmiar skompresowany (MB) Rozmiar nieskompresowany (MB)
iOS SDK Arm64 — 17,1 MB Arm64 — 61,1 MB
Android SDK x86 – 13,3 MB x86 – 33,75 MB
x86_64 – 13,3 MB x86_64 – 35,75 MB
Arm64-v8a — 13,1 MB Arm64-v8a – 37,02 MB
armeabi-v7a – 11.4 MB armeabi-v7a – 23.97 MB

Jeśli chcesz ulepszyć aplikację, zobacz artykuł Najlepsze rozwiązania. Zawiera on zalecenia i listę kontrolną do przejrzenia przed wydaniem aplikacji.

REST APIs

Interfejsy API usługi komunikacyjnej są udokumentowane wraz z innymi interfejsami API REST platformy Azure. W tej dokumentacji opisano sposób tworzenia struktury komunikatów HTTP i oferuje wskazówki dotyczące korzystania z narzędzia Postman. Dokumentacja interfejsu REST jest również publikowana w formacie OpenAPI w usłudze GitHub. Limity ograniczania przepustowości dla poszczególnych interfejsów API można znaleźć w limitach usługi.

Oczekiwania dotyczące stabilności interfejsu API

Ważne

Ta sekcja zawiera wskazówki dotyczące interfejsów API REST i zestawów SDK oznaczonych jako stabilne. Interfejsy API oznaczone jako wersja wstępna, wersja zapoznawcza lub beta mogą zostać zmienione lub oznaczone jako przestarzałe bez powiadomienia.

In the future we may retire versions of the Communication Services SDKs, and we may introduce breaking changes to our REST APIs and released SDKs. Usługi Azure Communication Services zwykle są zgodne z dwoma zasadami obsługi dotyczącymi wycofywania wersji usługi:

  • Otrzymasz powiadomienie co najmniej trzy lata, zanim będzie wymagane zmianę kodu z powodu zmiany interfejsu usług komunikacyjnych. All documented REST APIs and SDK APIs generally enjoy at least three years warning before interfaces are decommissioned.
  • Otrzymasz powiadomienie co najmniej rok przed koniecznością zaktualizowania zestawów SDK do najnowszej wersji pomocniczej. Te wymagane aktualizacje nie powinny wymagać żadnych zmian w kodzie, ponieważ są w tej samej wersji głównej. Korzystanie z najnowszego zestawu SDK jest szczególnie ważne w przypadku bibliotek połączeń i czatów, które często wymagają aktualizacji zabezpieczeń i wydajności w czasie rzeczywistym. Zdecydowanie zachęcamy do aktualizowania wszystkich zestawów SDK usług komunikacyjnych.

Przykłady likwidowania interfejsu API i zestawu SDK

Zintegrowałeś wersję 24 interfejsu API REST SMS ze swoją aplikacją. Azure Communication wydaje wersję 25.

You get three years warning before these APIs stop working and are forced to update to v25. Ta aktualizacja może wymagać zmiany kodu.

Zintegrowałeś wersję 2.02 pakietu SDK do wywołań z aplikacją. Usługa Azure Communication wydaje się w wersji 2.05.

Może być konieczne zaktualizowanie do wersji 2.05 zestawu Calling SDK w ciągu 12 miesięcy od wydania wersji 2.05. The update should be a replacement of the artifact without requiring a code change because v2.05 is in the v2 major version and has no breaking changes.

Następne kroki

Aby uzyskać więcej informacji, zobacz następujące omówienie zestawu SDK:

Aby rozpocząć pracę z usługami Azure Communication Services: