Udostępnij za pośrednictwem

Zestawy SDK i interfejsy API REST

  • Artykuł

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. Zestaw SDK wywołujący używa zastrzeżonych interfejsów sieciowych i jest zamknięty.

W poniższych tabelach podsumujemy te obszary i dostępność interfejsów API REST i bibliotek zestawu SDK. Należy pamiętać, że interfejsy API i zestawy SDK są przeznaczone dla klientów użytkowników końcowych lub zaufanych środowisk usług. Interfejsy API, takie jak SMS, nie powinny być bezpośrednio dostępne przez urządzenia użytkowników końcowych w środowiskach o niskim zaufaniu.

Tworzenie aplikacji rozmów i czatów można przyspieszyć za pomocą biblioteki interfejsu użytkownika usług 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 6 tygodni do raz w kwartale). Zaleca się utworzenie procesu w celu zapewnienia, że zawsze aktualizujesz zestawy SDK do najnowszych zestawów SDK.

Zestawy SDK

Zestaw Protokoły Środowisko Możliwości
Azure Resource Manager REST Usługa Aprowizuj zasoby usług Komunikacyjnych i zarządzaj nimi
Popularny Nie dotyczy Klient i usługa Udostępnia typy podstawowe dla innych zestawów SDK
Tożsamość REST Usługa Zarządzanie użytkownikami, 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 pobieranie stanu wiadomości e-mail
Czat Rest z zastrzeżonym sygnalizowaniem Klient i usługa Dodawanie czatu tekstowego w czasie rzeczywistym do aplikacji
Wywołanie Transport zastrzeżony Klient Komunikacja głosowa, wideo, udostępnianie ekranu i inna komunikacja w czasie rzeczywistym
Automatyzacja wywołań REST Usługa Tworzenie dostosowanych przepływów pracy wywoływania dla wywołań PSTN i VoIP
Router zadania REST Usługa Optymalizowanie zarządzania interakcjami klientów w różnych aplikacjach
Rooms REST Usługa Tworzenie pomieszczeń komunikacyjnych ze strukturą i zarządzanie nimi
Biblioteka interfejsu użytkownika Nie dotyczy Klient Składniki interfejsu użytkownika gotowe do produkcji na potrzeby czatu i wywoływania aplikacji
Zaawansowane komunikaty REST Usługa Wysyłanie i odbieranie wiadomości WhatsApp Business

Języki i lokalizacje publikowania

Lokalizacje publikowania dla poszczególnych pakietów ZESTAWU SDK:

Obszar JavaScript .NET Python Java SE iOS Android Inne
Azure Resource Manager npm NuGet PyPi Maven - - Przejdź za pośrednictwem usługi GitHub
Popularny npm NuGet Nie dotyczy Maven GitHub Maven -
Tożsamość npm NuGet PyPi Maven - - -
Numery telefonów npm NuGet PyPi Maven - - -
Czat npm NuGet PyPi Maven GitHub Maven -
SMS npm NuGet PyPi Maven - - -
Email npm NuGet PyPi Maven - - -
Wywołanie npm NuGet - - CocoaPods Maven -
Automatyzacja wywołań npm NuGet PyPi Maven
Router zadania npm NuGet PyPi Maven
Rooms 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 zestawu ANDROID Calling SDK

  • Obsługa interfejsu API systemu Android w wersji 21 lub nowszej
  • 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 opis Pomoc techniczna
Telefony i tablety Standardowe urządzenia z systemem Android Commercial. Pełna obsługa rozdzielczości wideo.

Uwaga

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

Jeśli podczas implementacji znaleziono problemy, zachęcamy do zapoznania się z przewodnikiem rozwiązywania problemów.

Obsługa zestawu SDK wywoływania systemu 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

Wywołanie obsługuje następujące platformy:

  • Platforma UWP z platformą .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+
    • Maksymalna liczba systemów operacyjnych 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

Rozmiar pakietu zestawu SDK

SDK Rozmiar skompresowany (MB) Rozmiar nieskompresowany (MB)
Zestaw SDK systemu iOS 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ę, zalecamy przeczytanie artykułu Najlepsze rozwiązania. Zawiera on zalecenia i listę kontrolną do przejrzenia przed wydaniem aplikacji.

Interfejsy API REST

Interfejsy API usług Communication Services są udokumentowane wraz z innymi interfejsami API REST platformy Azure. Ta dokumentacja zawiera informacje na temat struktury komunikatów HTTP i zawiera wskazówki dotyczące korzystania z narzędzia Postman. Dokumentacja interfejsu REST jest również publikowana w formacie struktury Swagger w usłudze GitHub. Limity ograniczania przepustowości dla poszczególnych interfejsów API można znaleźć na stronie limitów usług.

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 przestarzałe bez powiadomienia.

W przyszłości możemy wycofać wersje zestawów SDK usług komunikacyjnych i możemy wprowadzić zmiany powodujące niezgodność w naszych interfejsach API REST i wydane zestawy SDK. 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. Wszystkie udokumentowane interfejsy API REST i interfejsy API zestawu SDK zwykle korzystają z co najmniej trzech lat ostrzeżenia, zanim interfejsy zostaną zlikwidowane.
  • 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

Zintegrowano wersję interfejsu API REST programu SMS w wersji 24 z aplikacją. Usługa Azure Communication wydaje 25.

Otrzymasz ostrzeżenie o trzech latach, zanim te interfejsy API przestaną działać i zostaną zmuszone do aktualizacji do wersji 25. Ta aktualizacja może wymagać zmiany kodu.

Zintegrowano wersję 2.02 zestawu SDK wywołującego 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. Aktualizacja powinna być zastąpieniem artefaktu bez konieczności zmiany kodu, ponieważ wersja 2.05 jest w wersji głównej w wersji 2 i nie ma zmian powodujących niezgodność.

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: