SDK 和 REST API

Azure 通訊服務 功能在概念上會根據其功能區域組織成離散區域。 大部分區域都有針對已發佈的 REST API 進行程式設計的完整開放原始碼 SDK,您可以透過因特網直接使用。 呼叫 SDK 會使用專屬的網路介面,而且是封閉式來源。

在下表中,我們將摘要說明 REST API 和 SDK 連結庫的這些區域和可用性。 我們注意到 API 和 SDK 是否適用於使用者用戶端或受信任的服務環境。 在低信任環境中,用戶裝置不應直接存取SMS之類的API。

Azure 通訊服務 UI 連結庫可以加速通話和聊天應用程式的開發。 可自定義的UI連結庫提供Web和行動裝置應用程式的開放原始碼UI元件,以及 Microsoft Teams 主題。

SDK

組件 通訊協定 Environment 功能
Azure Resource Manager REST 服務 布建和管理通訊服務資源
常見 N/A 用戶端和服務 提供其他 SDK 的基底類型
身分識別 REST 服務 管理使用者、存取令牌
電話號碼 REST 服務 取得和管理電話號碼
SMS REST 服務 傳送和接收簡訊
電子郵件 REST 服務 傳送並取得電子郵件訊息的狀態
聊天 具有專屬訊號的 REST 用戶端和服務 將即時文字聊天新增至您的應用程式
通話 專屬傳輸 用戶端 語音、視訊、螢幕共用和其他實時通訊
呼叫自動化 REST 服務 建置 PSTN 和 VoIP 通話的自定義通話工作流程
作業路由器 REST 服務 優化跨各種應用程式的客戶互動管理
網路周遊 REST 服務 存取低階數據傳輸的 TURN 伺服器
房間 REST 服務 建立和管理結構化通訊室
UI 程式庫 N/A 用戶端 聊天和通話應用程式的生產就緒UI元件

語言和發佈位置

個別 SDK 套件的發佈位置如下所述。

區域 JavaScript .NET Python Java SE iOS Android 其他
Azure Resource Manager npm \(英文\) NuGet (英文) PyPi Maven - - 透過 GitHub 進行
常見 npm \(英文\) NuGet (英文) N/A Maven GitHub Maven -
身分識別 npm \(英文\) NuGet (英文) PyPi Maven - - -
電話號碼 npm \(英文\) NuGet (英文) PyPi Maven - - -
聊天 npm \(英文\) NuGet (英文) PyPi Maven GitHub Maven -
SMS npm \(英文\) NuGet (英文) PyPi Maven - - -
電子郵件 npm \(英文\) NuGet (英文) PyPi Maven - - -
通話 npm \(英文\) NuGet (英文) - - CocoaPods \(英文\) Maven -
呼叫自動化 npm \(英文\) NuGet (英文) PyPi Maven
作業路由器 npm \(英文\) NuGet (英文) PyPi Maven
網路周遊 npm \(英文\) NuGet (英文) PyPi Maven - - -
房間 npm \(英文\) NuGet (英文) PyPi Maven - - -
UI 程式庫 npm \(英文\) - - - GitHub GitHub GitHubStorybook
進階傳訊 - NuGet (英文) - - - - -
參考文件 docs docs docs docs docs docs -

SDK 平臺支援詳細數據

Android 通話 SDK 支援

  • 支援 Android API 層級 21 或更高版本
  • 支援 Java 7 或更新版本
  • 支援 Android Studio 2.0
  • 目前不支援執行 Android 的 Android Auto(AAOS)IoT 裝置

iOS 通話 SDK 支援

  • 在建置階段支援 iOS 10.0+ 和運行時間的 iOS 12.0+
  • Xcode 12.0+
  • 支援 iPadOS 13.0+

.NET

呼叫 支援下列平臺。

  • UWP 搭配 .NET Native 或 C++/WinRT
    • Windows 10/11 10.0.17763 - 10.0.22621.0
    • Windows Server 2019/2022 10.0.17763 - 10.0.22621.0
  • WinUI3 與 .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

所有其他通訊服務套件都以 .NET Standard 2.0 為目標,其支援下列平臺。

  • 透過 .NET Framework 4.6.1 的支援
    • Windows 10、8.1、8 和 7
    • Windows Server 2012 R2、2012 和 2008 R2 SP1
  • 透過 .NET Core 2.0 的支援:
    • Windows 10 (1607+)、7 SP1+、8.1
    • Windows Server 2008 R2 SP1+
    • 最大OS X 10.12+
    • Linux 多個版本/散發套件
    • UWP 10.0.16299 (RS3) 2017 年 9 月
    • Unity 2018.1
    • Mono 5.4
    • Xamarin iOS 10.14
    • Xamarin Mac 3.8

REST API

通訊服務 API 會與其他 Azure REST API 一起記載。 本文件將告訴您如何建構 HTTP 訊息,並提供使用 Postman 的指引。 REST 介面檔也會以 GitHub 上的 Swagger 格式發佈。 您可以在服務限制頁面上找到個別 API 的節流限制。

API 穩定性預期

重要

本節提供標示為穩定之 REST API 和 SDK 的指引。 標示為發行前版本、預覽或 Beta 的 API 可能會變更或取代, 而不通知

未來,我們可能會淘汰通訊服務 SDK 的版本,而我們可能會對 REST API 和發行 SDK 引入重大變更。 Azure 通訊服務 通常會遵循兩個淘汰服務版本的支持性原則:

  • 由於通訊服務介面變更,您必須在變更程式碼前至少三年收到通知。 所有記載的 REST API 和 SDK API 通常會在介面解除委任前至少享受三年的警告。
  • 您必須至少收到一年的通知,才能將 SDK 元件更新為最新的次要版本。 這些必要的更新不應該要求任何程式碼變更,因為它們位於相同的主要版本。 對於經常需要安全性和效能更新的即時元件,使用最新的 SDK 對於通話和聊天連結庫來說尤其重要。 強烈建議您隨時更新所有通訊服務 SDK。

API 和 SDK 解除委任範例

您已將 V24 版的 SMS REST API 整合到應用程式中。 Azure 通訊版本 v25。

在這些 API 停止運作之前,您將會收到三年的警告,並被迫更新至 v25。 此更新可能需要變更程序代碼。

您已將呼叫 SDK v2.02 版整合到您的應用程式中。 Azure 通訊版本 v2.05。

您可能需要在 2.05 版 v2.05 版的 v2.05 版內更新呼叫 SDK。 這應該是成品的簡單取代,而不需要變更程式代碼,因為 v2.05 位於 v2 主要版本,而且沒有重大變更。

下一步

如需詳細資訊,請參閱下列 SDK 概觀:

若要開始使用 Azure 通訊服務: