昨今、働き方改革の推進によるテレワークの導入や、新型コロナウイルスの流行を経て、ウェビナーやオンライン商談などの需要も増え、Zoomを利用している方も多くなってきています。その中で、Zoomの機能をアプリケーションやサービスに統合できる、Zoom APIの活用が注目を集めています。
本記事では、Zoom APIで何ができるのか、提供するAPIの一覧、連携可能なアプリケーションの例、OAuth認証について、初心者でも理解しやすいようにご紹介します。
Zoom APIとは
Zoom APIとは、開発者がZoomのビデオ会議プラットフォームをアプリケーションやサービスに統合できるようにするためのインターフェースです。ユーザー情報の取得、会議の作成や削除など、Zoom上での様々な操作をプログラムから実行できます。OAuth 2.0による認証をサポートしており、安全にZoomのリソースにアクセスすることが可能です。Zoom APIを利用することで、Zoomの強力なコミュニケーション機能を自社のアプリケーションやサービスに簡単に組み込むことができます。
Zoom APIでできること
Zoom APIを使用すると、開発者はZoomの機能を自分のアプリケーションやサービスに統合できます。これには、ユーザーの詳細情報の取得、会議やウェビナーのスケジュール設定、会議記録の削除などが含まれます。また、ユーザーの代わりにZoomプラットフォーム上でアクションを実行することも可能です。OAuth 2.0認証を通じて安全にこれらの操作を行うことができ、Zoomのビデオ、音声通話、画面共有などの強力な機能を自社のアプリケーションに容易に組み込むことができます。
Zoom API 一覧
Zoom APIは、Zoomの機能を外部のアプリケーションやサービスと統合するための多様なAPIを提供しています。
主なAPIには以下のようなものがあります。
| Zoom API名 | 概要 | 詳細 |
|---|---|---|
| Zoom User API | 連絡先グループ、グループ、 およびユーザーに関連するデータにアクセスできる |
詳細はこちら |
| Zoom Meeting API | Zoom Meeting のデータにアクセスできる | 詳細はこちら |
| Zoom Account API | アカウント、ダッシュボードに関連する データにアクセスできる |
詳細はこちら |
| Zoom Phone API | Zoom Phone をサードパーティのアプリケーション またはサービスに統合できる |
詳細はこちら |
| Zoom Contact Center API | Zoom Contact Center のデータにアクセスできる | 詳細はこちら |
| Zoom Video SDK API | Zoom Videoのデータにアクセスできる | 詳細はこちら |
| Zoom Events API | イベント管理のための機能 | 詳細はこちら |
| Zoom Chat API | チャットおよびチャット チャネル データにアクセスできる | 詳細はこちら |
| Zoom Rooms API | Zoom Roomsのデータにアクセスできる | 詳細はこちら |
| Marketplace API | Zoom App Marketplaceでプライベートサービス またはパブリック アプリケーションを構築できる |
詳細はこちら |
| Quality of Service Subscription (QSS) API | ユーザー、主催者、会議、ウェビナー、電話の参加者の ネットワーク トラフィックに関する詳細を ほぼリアルタイムで受信できるようにするオプション |
詳細はこちら |
| Zoom Billing API | アカウントとサブアカウントの料金プランに関する情報を取得できる | 詳細はこちら |
| Zoom Whiteboard API | ホワイトボード機能との統合ができる | 詳細はこちら |
| Conference Room Connector API | Conference Room Connectorの機能を統合、拡張できる | 詳細はこちら |
これらのAPIを利用することで、Zoomのビデオ会議機能を自社のアプリケーションやワークフローにシームレスに組み込むことが可能になります。Zoom APIはRESTful設計が採用されており、OAuth 2.0による認証をサポートしています。これにより、開発者は安全にZoomのリソースを操作できます。
※詳細は公式サイトをご参考ください
Zoom APIに連携できるアプリ
Zoom APIは、さまざまなアプリケーションとの連携を可能にする柔軟性を持っています。上述でも紹介しているMarketplace APIを利用すると、開発者はZoom App Marketplaceにある様々な機能を自社のアプリケーションやサービスに統合できます。
主な連携可能なアプリには以下のようなものがあります。
- スケジューリングアプリ：会議の自動スケジュール設定や更新。
- 例）Googleカレンダー、Coubic、TimeRexなど
- プロジェクト管理ツール：チームミーティングのスケジュールやフォローアップ。
- 例）Jira、Asana、Slackなど
- CRMシステム：顧客とのコミュニケーションを管理し、Zoom会議を直接スケジュール。
- 例）Salesforce Account Engagement(旧Pardot)、Marketo、HubSpotなど
- 教育プラットフォーム：オンラインクラスやウェビナーの管理。
- 例）Qumu、Kahoot!など
※Zoom App Marketplace はこちら
Zoom APIを利用することで、これらのアプリケーション内から直接Zoomの機能にアクセスし、ユーザー体験を向上させることができます。APIの柔軟性と広範な機能により、あらゆるタイプのアプリケーションとの統合が可能になります。
Zoom API 使い方（概要）
Zoom APIの使い方は、開発者がZoomの機能を自分のアプリケーションやサービスに統合するためのステップバイステップのプロセスを含みます。
基本的な手順は以下の通りです。
- Zoom Marketplaceでアプリを登録：Zoom APIを使用するには、まずZoom Marketplaceでアプリを登録し、必要な認証情報（Client IDとClient Secret）を取得します。
- OAuth認証を設定：Zoom APIはOAuth 2.0認証を使用します。アプリがユーザーのZoomデータにアクセスするためには、ユーザーからの認証と承認が必要です。
- APIリクエストを行う：認証が完了したら、HTTPリクエストを使用してZoom APIにアクセスし、ユーザー情報の取得、会議の作成や削除などの操作を行います。
- レスポンスを処理：APIからのレスポンスを適切に処理し、アプリケーション内で必要な情報を表示または使用します。
上記の手順を参考に、実際の社内システムから新規ミーティングを作成する方法については、別記事にて解説する予定です。（現在準備中）
実際に開発する際には、Zoom Japanさんのこちらの記事、またはZoom APIドキュメントをご参考ください。Zoom APIのドキュメントは詳細なガイドライン、使用可能なAPIエンドポイントのリスト、リクエストとレスポンスの例を提供しており、開発者がAPIを効率的に利用するためのサポートを提供します。
Zoom API OAuthについて
Zoomサーバへのリクエストを認証するためにトークンを使いますが、Server-To-Server OAuth Appsを作成しておく必要があります。
以前は、JWT Appsを作成する方法が多く紹介されていましたが、JWTは2023年9月8日に廃止されました。
Server-to-server OAuthの利用もしくはOAuthでの実装をしましょう。
ただし、Server to Server OAuth App は社内利用(Internal usage)でのみの許容されており、自社で開発したプラットフォームへユーザからIDや生成後のトークンを共有してもらう実装は、規約に反してしまうので注意が必要です。
※JWT Apps廃止の詳細はこちらをご参考ください
※Server-to-server OAuthの実装に関しては、Zoom Japanさんのこちらの記事をご参考ください
Zoom API 料金
Zoom APIの利用に関する料金は、主に使用するAPIの種類と呼び出し回数に基づいています。基本的に、Zoom APIを使用するための初期費用は無料ですが、特定のAPIや大量のリクエストを使用する場合、追加料金が発生することがあります。
料金体系は以下のように構成されています。
- 基本利用：Zoom APIの基本的な機能は無料で利用できます。これにはユーザー管理、会議のスケジュール設定などが含まれます。
- 高度な機能：特定の高度なAPI機能や、大規模なデータ処理が必要な場合、追加料金が発生する可能性があります。
- API呼び出し制限：ZoomはAPIの呼び出し回数に制限を設けており、この制限を超えると追加料金が発生することがあります。
料金に関する詳細や、API呼び出しの制限については、Zoomの公式ドキュメントやZoom Marketplaceの情報を参照してください。また、特定のプロジェクトやビジネスニーズに合わせた料金プランについては、Zoomのサポートチームに直接お問い合わせすることをお勧めします。
まとめ
Zoom APIは、Zoomの機能を自社アプリケーションやサービスに統合できるインターフェースです。ユーザー情報の取得、会議のスケジュール設定、会議記録の削除など、多様な操作を可能にします。RESTful設計を採用し、多様なAPIを提供しており、アプリケーションやサービスとの柔軟な連携が可能です。自社アプリケーションやサービスのユーザー体験を向上させるために、Zoom APIの活用を検討してはいかがでしょうか。
