SDK と REST API
Azure Communication Services 機能は、機能領域に基づいて、概念的に個別の領域に分類されています。 ほとんどの領域には、インターネット経由で直接使用できる、公開された REST API に対してプログラミングされた、完全にオープンソースである SDK があります。 Calling SDK は独自のネットワーク インターフェイスを使用しており、クローズ ドソースです。
下の表は、これらの領域と、REST API および SDK ライブラリの利用可能性をまとめたものです。 また、API と SDK がエンド ユーザー クライアント向けか、信頼できるサービス環境向けかについても記載してあります。 信頼性の低い環境では、エンド ユーザー デバイスを使って SMS などの API に直接アクセスしなでください。
Azure Communication Services UI ライブラリを使うと、通話やチャット アプリケーションの開発期間を短縮できます。 このカスタマイズ可能な UI ライブラリは、Web アプリとモバイル アプリ用のオープンソース UI コンポーネントと、Microsoft Teams のテーマを提供しています。
最新の SDK を使用するプラクティスの作成
ブラウザーとオペレーティング システムは、最新の機能強化をサポートし、既存のバグを修正するために絶えず進化しています。 最新の Azure Communication Services SDK を使用すると、更新されたブラウザーやオペレーティング システムの更新プログラムと共に使用する場合に、アプリケーションの全体的なエンド ユーザー エクスペリエンスを最大限に高めることができます。 最新の Azure Communication Services SDK には、パフォーマンス、セキュリティ、互換性、品質、使いやすさの向上など、多くの利点があります。 更新すると、ブラウザーとオペレーティング システムに定期的に追加される最新の機能と更新プログラムにアクセスできます。 Azure Communication Services SDK は頻繁に更新されます (およそ 6 週間から四半期に 1 回)。 最新の SDK に常に確実に更新するためのプロセスを作成することをお勧めします。
SDK
| アセンブリ | プロトコル | 環境 | 機能 |
|---|---|---|---|
| Azure Resource Manager | REST | Service | Communication Services のリソースをプロビジョニングおよび管理します。 |
| 共通 | 該当なし | クライアントとサービス | 他の SDK の基本型を指定します。 |
| ID | REST | Service | ユーザーとアクセス トークンを管理します。 |
| 電話番号 | REST | Service | 電話番号を取得して管理します。 |
| sms | REST | Service | SMS メッセージを送信および受信します。 |
| メール | REST | Service | メール メッセージの送信と状態の取得を行います。 |
| チャット | 独自の通知を含む REST | クライアントとサービス | リアルタイムのテキスト チャットをアプリケーションに追加します。 |
| 通話 | 独自の転送 | クライアント | 音声、ビデオ、画面共有、その他のリアルタイム通信。 |
| 呼び出し自動化 | REST | Service | PSTN と VoIP 通話用にカスタマイズされた通話ワークフローを構築します。 |
| Job Router | REST | Service | さまざまなアプリケーションでの顧客との対話の管理を最適化します。 |
| 部屋 | REST | Service | 構造化されたコミュニケーション ルームを作成して管理します。 |
| UI ライブラリ | 該当なし | クライアント | チャットと通話アプリ用の運用対応 UI コンポーネント。 |
| Advanced Messaging | REST | Service | WhatsApp Business メッセージを送受信します。 |
言語と公開場所
個々の SDK パッケージの公開場所は次のとおりです。
| 面グラフ | JavaScript | .NET | Python | Java SE | iOS | Android | その他 |
|---|---|---|---|---|---|---|---|
| Azure Resource Manager | npm | NuGet | PyPi | Maven | - | - | GitHub 経由の Go |
| 共通 | npm | NuGet | 該当なし | Maven | GitHub | Maven | - |
| ID | 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 | |||
| Job Router | npm | NuGet | PyPi | Maven | |||
| 部屋 | npm | NuGet | PyPi | Maven | - | - | - |
| UI ライブラリ | npm | - | - | - | GitHub | GitHub | GitHub、Storybook |
| Advanced Messaging | npm | NuGet | PyPi | Maven | - | - | - |
| リファレンス ドキュメント | docs | docs | docs | docs | docs | docs | - |
SDK プラットフォーム サポートの詳細
Android Calling SDK のサポート
- Android API レベル 21 以上のサポート
- Java 7 以上のサポート
- Android Studio 2.0 のサポート
Android プラットフォームのサポート
Android エコシステムは多岐にわたり、さまざまなバージョンと、多様な種類のデバイス用に設計された特殊なプラットフォームを含みます。 次の表は現在サポートされている Android プラットフォームを一覧表示したものです。
| デバイス | 説明 | サポート |
|---|---|---|
| スマートフォンとタブレット PC | Android Commercial を実行する標準デバイス。 | 完全サポートとビデオ解像度。 |
Note
私たちがサポートするのはスマートフォンとタブレット上のビデオ通話だけです。 標準ではないデバイスやプラットフォーム (スマート グラスやカスタム デバイスなど) でのビデオを含むユース ケースの場合は、開発プロセスの早い段階でこちらまでご連絡頂き、最適な統合アプローチの決定に関する支援を受けることをお勧めします。
実装中に問題が見つかった場合は、トラブルシューティング ガイドに関する記事をご覧ください。
iOS Calling SDK のサポート
- ビルド時の iOS 10.0 以上と実行時の iOS 12.0 以上のサポート
- Xcode 12.0 以上
- iPadOS 13.0 以降のサポート
.NET
Calling では、次のプラットフォームをサポートしています。
- .NET ネイティブまたは C++/WinRT を使用した UWP
- Windows 10/11 10.0.17763 - 10.0.22621.0
- Windows Server 2019/2022 10.0.17763 - 10.0.22621.0
- .NET 6 を使用した WinUI3
- 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
その他の Communication Services パッケージはすべて、次のプラットフォームをサポートしている .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+
- Max 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
SDK パッケージ サイズ
| SDK | 圧縮サイズ (MB) | 圧縮前のサイズ (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 |
アプリを改善する場合は、ベスト プラクティスに関する記事をご覧ください。 アプリをリリースする前に確認するための推奨事項とチェックリストが用意されています。
REST API
他の Azure REST API と共に、Communication Services API について説明されています。 このドキュメントでは、HTTP メッセージの構成方法が説明されており、Postman の使用に関するガイダンスが提供されています。 GitHub では、REST インターフェイスのドキュメントが OpenAPI 形式でも公開されています。 個々の API のスロットル制限については、サービスの制限に関する記事で確認できます。
API の安定性に関する想定
重要
このセクションでは、安定とマークされている REST API および SDK に関するガイダンスを提供します。 プレリリース、プレビュー、またはベータとマークされている API は、予告なしに変更されたり非推奨になったりする場合があります。
将来的に、Communication Services SDK のバージョンが廃止される可能性があります。また、REST API とリリースされた SDK に対して破壊的変更が加えられる可能性があります。 Azure Communication Services は、サービス バージョンの廃止に関して、"通常は" 次の 2 つのサポート ポリシーに従います。
- Communication Services インターフェイスの変更に起因するコードの変更を求められる場合、お客様は少なくとも 3 年前に通知されます。 通常、ドキュメントに記載されているすべての REST API と SDK API では、インターフェイスが使用停止になる前に少なくとも 3 年間警告が発生します。
- お客様は、SDK アセンブリを最新のマイナー バージョンに更新する必要が生じる少なくとも 1 年前に通知されます。 これらの必須の更新は、同じメジャー バージョンに含まれているため、コードを変更する必要はありません。 最新の SDK を使用することは、セキュリティとパフォーマンスに関する更新を頻繁に必要とするリアルタイム コンポーネントである Calling および Chat ライブラリにとって特に重要です。 すべての Communication Services SDK を最新の状態に保つことを強くお勧めします。
API と SDK の廃止の例
v24 バージョンの SMS REST API をアプリケーションに統合しました。 Azure Communication では v25 がリリースされています。
これらの API の機能が停止し、v25 に強制的に更新される 3 年前から、警告が表示されます。 この更新ではコードの変更が必要になる場合があります。
v2.02 バージョンの Calling SDK をアプリケーションに統合しました。 Azure Communication では v2.05 がリリースされています。
v2.05 バージョンの Calling SDK への更新を、v2.05 のリリースから 12 か月以内に求められる場合があります。 この更新プログラムはコードを変更せず、成果物を置き換えるだけで済みます。v2.05 は v2 メジャー バージョンに含まれ、破壊的変更はないためです。
次のステップ
詳細については、次の SDK の概要を参照してください。
- Calling SDK の概要
- Call Automation SDK の概要
- Job Router SDK の概要
- Chat SDK の概要
- SMS SDK の概要
- メール SDK の概要
- Advanced Messaging SDK の概要
Azure Communication Services の使用を開始するには: