Microsoft Graph API を使用して Microsoft Teams で作業する
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Teams は、Microsoft 365 のチャットベースのワークスペースであり、チーム固有の予定表、ファイル、OneNote のノート、Planner のプラン、シフトのスケジュールなどへの組み込みのアクセスを提供します。 Microsoft Graph APIを使用して、Microsoft Teams機能と統合できます。
一般的なユース ケース
次の表に、Microsoft Graph のMicrosoft Teams API の一般的なユース ケースを示します。
ユース ケース | REST リソース | 関連項目 |
---|---|---|
チーム、グループ、チャネルの作成と管理 | チーム、 チャネル、 グループ | チームの作成、 チームの一覧表示、 チャネルの作成 |
Microsoft Teams アプリ カタログにタブを追加する、アプリを管理する、またはインストールする | teamsTab,teamsAppInstallation | teamsTab の作成、 teamsTab の一覧表示、 インストール済みアプリの一覧表示 |
チャット メッセージを送受信するチャネルとチャットを作成する | channel, chat, chatMessage | チャネルの作成、 チャネルの一覧表示、 チャネルでの chatMessage の送信 |
タグを使用して、チーム内の一般的な属性に基づいてユーザーまたはグループを分類する | teamworkTag, teamworkTagMember | teamworkTag の一覧表示、 teamworkTag の作成 |
通話の作成と受信、通話レコードの作成、会議座標の取得 | call, callRecords | 回答、 参加者を招待する |
ボットを呼び出しに接続し、対話型音声応答 (IVR) を実装する | 通話 | IVR のシナリオ |
オンライン会議の作成と取得、またはユーザーのプレゼンスとアクティビティのチェック | onlineMeeting, presence | onlineMeeting の作成、 meetingAttendanceReport |
organizationでシフト、スケジュール、タイム カード、休暇を使用して従業員の統合を作成および管理する | workforceIntegration, schedule, shift, timeOff, timeOffReason | workforceIntegration の作成、 スケジュールの作成、シフトの 作成、 timeOff の作成 |
従業員の学習 API を使用してViva Learningと統合する | 従業員の学習, learningProvider, learningContent | list learningProviders, list learningContents |
IVR のシナリオ
Microsoft Graph の呼び出し元 API がサポートする対話型音声応答 (IVR) シナリオを次に示します。
- 音声プロンプトを再生する - たとえば、顧客サービス エージェントのキューに通話が行われた場合などです。
- 応答を録音する - たとえば、発信者のオーディオを録音するには、通常、オプションを含むプロンプトを聞いた後に。
- トーンをサブスクライブする - たとえば、発信者が選択した DTMF トーンを知りたい場合(通常はオーディオ プロンプトを聞いた後)。
- メディア処理を取り消す - たとえば、 処理中の playPrompt 操作や recordResponse 操作を取り消す場合などです。
Microsoft Teams の制限
テスト済みの Microsoft Teams のパフォーマンスと容量の制限は、「Microsoft Teams の制限事項と仕様」に記載されています。 これらの制限は、Microsoft Teams を直接使用している場合でも、Microsoft Graph API を使用している場合でも適用されます。 すべてのチームには対応するグループがあり、すべてのグループはディレクトリ オブジェクトであるため、グループの数やディレクトリ オブジェクトの数 ("リソース") に制限が発生する可能性もあります。
チャネル内のファイルは SharePoint に保存され、SharePoint Online の制限が適用されます。
詳細については、「throttling limits for Microsoft Teams services (Microsoft Teams サービスの制限の調整)」を参照してください。
チームとグループ
Microsoft Graph では、Microsoft Teams は group リソースとして表されます。 Microsoft Teams と Microsoft 365 の両方のグループは、グループの共同作業のためのさまざまなニーズに対応します。 ほとんどのグループベースの機能 (グループの予定表、ファイル、ノート、写真、プランなど) は Microsoft Teams グループと Microsoft 365 グループに適用されます。 チーム と Microsoft 365 のグループの主な違いは、メンバー間のコミュニケション モードです。 チーム メンバーのコミュニケーションには、特定のチームのコンテキストで常設チャットが使用されます。 Microsoft 365 グループ メンバーのコミュニケーションには、グループ会話 (Outlook のグループのコンテキストで行われるメールによる会話) が使用されます。
チームを持つすべてのグループでは resourceProvisioningOptions プロパティが "Team" に設定されています。
注:Group.resourceProvisioningOptions プロパティは変更可能です。 このコレクションで "Team" を追加または削除しないでください。このようにすると、すべてのチームを一覧表示するときに誤った結果が表示されます。
チームとグループの API レベルでの違いを以下に示します。
- 常設チャットは、Microsoft Teams でのみ使用できます。 この機能は、channel および chatMessage リソースにより階層的に表されます。
- グループ会話は、Microsoft 365 グループでのみ使用できます。 この機能は、channel、conversationThread、および post リソースにより階層的に表されます。
- 「参加チームの一覧表示」メソッドは Microsoft Teams のみに適用されます。
- 通話 API と オンライン会議 API は、Microsoft Teamsにのみ適用されます。
- これらの API に関する既知の問題も参照してください。
Microsoft Teams のメンバーシップの変更
ユース ケース | 動詞 | URL |
---|---|---|
メンバーを追加する | POST | /teams/{team-id}/members |
メンバーを削除する | DELETE | /teams/{team-id}/members/{membership-id} |
メンバーの役割を更新する | PATCH | /teams/{team-id}/members/{membership-id} |
チームを更新する | PATCH | /teams/{team-id} |
ポーリングの要件
リソースが変更されたかどうかを確認するためにアプリがポーリングを行う場合、実行できるのは 1 日に 1 回だけです。 (teamsAsyncOperation は、頻繁にポーリングされることを意図しているという点で例外です。) それよりも頻繁に変更について知る必要がある場合は、そのリソースのサブスクリプションを作成し、変更通知 (Webhooks) を受け取る必要があります。 必要なサブスクリプションの種類に対するサポートが見つからない場合は、Microsoft 365 開発者プラットフォーム アイデア フォーラム を通じてフィードバックを提供してください。
新しいメッセージをポーリングする場合、サポートされている場合は日付の範囲を指定する必要があります。 詳細については、「 ユーザーのデルタ チャット メッセージを取得する」を参照してください。
ポーリングとは、リソースが変更されたかどうかを確認するために、リソースに対して何度も GET 操作を行うことをさします。 それがポーリングではない限り、同じリソースに対して 1 日に複数回 GET 操作を行うことができます。 たとえば、ユーザーが Web ページにアクセス/更新するたびに /me/joinedTeams を取得してもかまいませんが、その Web ページを更新するために 30 秒ごとにループで /me/joinedTeams を取得しても問題ありません。
これらのポーリング要件に従わないアプリは、Microsoft API の使用条件に違反していると見なされます。 これにより、追加の調整が発生したり、Microsoft API の使用が停止または終了したりする可能性があります。