名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
1 人以上の参加者間の chatMessages のコレクションであるチャットを表します。 参加者には、ユーザーまたはアプリを指定できます。
注: チャットが onlineMeeting インスタンスに関連付けられている場合、一覧表示されているメソッドの一部は会議に推移的に影響します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャット管理 | ||
| List | チャット コレクション | ユーザーが参加しているチャットの一覧を取得します。 |
| Create | チャット | 新しいチャットを作成します。 |
| Get | チャット | チャットのプロパティと関係を読み取ります。 |
| Update | チャット | チャットのプロパティを更新します。 |
| Delete | なし | チャットを削除します。 |
| ユーザーのすべてのアクセスを削除する | なし | ユーザーのチャットへのアクセス権を削除します。 |
| メンバーを一覧表示する | conversationMember コレクション | チャットのすべてのメンバーのリストを取得します。 |
| メンバーを追加する | Location ヘッダー | チャットにユーザーを追加します。 |
| メンバーを取得する | conversationMember | チャットの 1 人のユーザーを取得します。 |
| メンバーを削除する | なし | チャットからユーザーを削除します。 |
| ユーザーとアプリの間でチャットを行う | チャット | ユーザーとアプリの間で 1 対 1 のチャットを行います。 |
| チャットを開封済みにする | なし | ユーザーのチャットを既読にする。 |
| チャットを未読にする | なし | ユーザーのチャットを未読としてマークする。 |
| チャットを非表示にする | なし | ユーザーのチャットを非表示にする。 |
| チャットを再表示する | なし | ユーザーのチャットを再表示します。 |
| 移行の開始 | チャット | 既存の チャットで移行モードを有効にして、外部メッセージの移行を開始します。 |
| Complete migration | チャット | チャットから移行モードを削除して、外部メッセージの移行を完了します。 |
| メッセージ | ||
| チャット内のメッセージを一覧表示する | chatMessage | チャットでメッセージを取得する。 |
| メッセージの返信を取得する | chatMessage | チャット内の 1 つのメッセージを取得します。 |
| ユーザーのすべてのチャットでメッセージを取得する | チャット コレクション | ユーザーが参加しているすべてのチャットからメッセージを取得します。 |
| すべてのチャットで保持されているメッセージを取得する | chatMessage コレクション | 1 対 1 のチャット、グループ チャット、会議チャットなど、ユーザーが参加しているすべてのチャットからすべての保持メッセージを取得します。 |
| ユーザーのデルタ チャット メッセージを取得する | chatMessage コレクション | 1 対 1 のチャット、グループ チャット、会議チャットなど、ユーザーが参加しているすべてのチャットからメッセージのリストを取得します。 |
| アプリ | ||
| チャットのアプリを一覧表示する | teamsAppInstallation コレクション | チャット (および関連する会議) にインストールされているアプリを一覧表示します。 |
| チャットでのインストール済みアプリを取得する | teamsAppInstallation | チャット (および関連する会議) に特定のアプリをインストールします。 |
| アプリをチャットに追加する | チャット (および関連する会議) にアプリを追加 (インストール) します。 | |
| チャットにインストールされたアプリをアップグレードする | なし | チャット (および関連する会議) にインストールされているアプリの最新バージョンに更新します。 |
| チャットからアプリを削除する | なし | チャット (および関連する会議) からアプリを削除 (アンインストール) します。 |
| 権限付与の表示 | resourceSpecificPermissionGrant コレクション | このチャットでアプリに付与されたアクセス許可を一覧表示します。 |
| タブ | ||
| チャットでタブを一覧表示する | teamsTab | チャット (および関連する会議) にピン留めされているタブを一覧表示します。 |
| チャットでタブを取得する | teamsTab | チャット (および関連する会議) にピン留めされた特定のタブを取得します。 |
| チャットにタブを追加する | teamsTab | チャット (および関連する会議) にタブを追加 (ピン留め) します。 |
| チャットでタブを更新する | teamsTab | チャット (および関連する会議) のタブのプロパティを更新します。 |
| チャットからタブを削除する | なし | チャット (および関連する会議) からタブを削除 (ピン留め解除) します。 |
| 操作 | ||
| リスト操作 | teamsAsyncOperation コレクション | チャットで実行された、または実行されている非同期操作の一覧を取得します。 |
| チャットでの操作の取得 | teamsAsyncOperation | チャットで実行された、または実行中の 1 つの非同期操作を取得します。 |
| ピン留めされたメッセージ | ||
| ピン留めされたメッセージを一覧表示する | pinnedChatMessageInfo コレクション | チャットでピン留めされたメッセージのリストを取得します。 |
| メッセージをピン留めする | pinnedChatMessageInfo | チャットでチャット メッセージをピン留めします。 |
| メッセージのピン留めを解除する | なし | チャットからメッセージのピン留めを外します。 |
メモ: アプリケーションのアクセス許可を使用する場合は、チャット ID を取得する方法を理解していることを確認してください。 アプリケーションのアクセス許可を持つチャットの一覧表示はサポートされていないため、すべてのシナリオが可能なわけではありません。 委任されたアクセス許可を使用してチャット ID を取得し、アプリケーションのアクセス許可を使用して /chats/getAllMessages の変更 通知から取得することができます。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| chatType | chatType | チャットの種類を指定します。 使用可能な値: group、oneOnOne、meeting、unknownFutureValue。 |
| createdBy | identitySet | チャットを作成したユーザーまたはアプリケーション。 読み取り専用です。 |
| createdDateTime | dateTimeOffset | チャットが作成された日時。 読み取り専用です。 |
| id | 文字列 | チャットの一意識別子。 読み取り専用です。 |
| isHiddenForAllMembers | ブール型 | チャットがすべてのメンバーに対して非表示になっているかどうかを示します。 読み取り専用です。 |
| lastUpdatedDateTime | dateTimeOffset | チャットの名前が変更された日時、またはメンバーのリストが最後に変更された日時。 読み取り専用です。 |
| migrationMode | migrationMode | チャットが移行モードかどうかを示します。 この値は、移行モードに移行されたことのないチャットに対して null されます。 使用可能な値: inProgress、completed、unknownFutureValue。 |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | オンライン会議に関する詳細を表します。 チャットがオンライン会議に関連付けられていない場合、プロパティは空です。 読み取り専用です。 |
| originalCreatedDateTime | dateTimeOffset | チャットの最初の作成時刻のタイムスタンプ。 チャットが移行モードにならなかった場合、値は null です。 |
| tenantId | String | チャットが作成されたテナントの識別子。 読み取り専用です。 |
| topic | 文字列 | (オプション)チャットの件名またはトピック。 グループ チャットでのみ使用できます。 |
| viewpoint | chatViewpoint | 最後にメッセージを読んだ日時など、チャットに関する発信者固有の情報を表します。 このプロパティは、要求が委任されたコンテキストで行われた場合にのみ設定されます。 |
| webUrl | String | Microsoft Teams でのチャットの URL。 URL は非透過的な BLOB として扱い、解析しないでください。 読み取り専用です。 |
chatType 値
| メンバー | 説明 |
|---|---|
| oneOnOne | チャットが 1:1 チャットであることを示します。 この種類のチャットの参加者一覧のサイズは固定されています。メンバーの削除/追加はできません。 |
| グループ | チャットがグループ チャットであることを示します。 この種類のチャットの名簿サイズ (2 人以上) を更新できます。 メンバーは後で削除/追加できます。 |
| 会議 | チャットがオンライン会議に関連付けられていることを示します。 この種類のチャットは、オンライン会議の作成の一部としてのみ作成されます。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
migrationMode 値
| メンバー | 説明 |
|---|---|
| inProgress | Chat は移行モードに移行されました。 |
| completed | Chat は移行モードから外れています。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| installedApps | teamsAppInstallation コレクション | チャット内のすべてのアプリのコレクション。 Null 許容型。 |
| lastMessagePreview | chatMessageInfo | チャットで送信された最後のメッセージのプレビュー。
Null チャットでメッセージが送信されない場合。 現時点では、 チャットの一覧 操作のみがこのプロパティをサポートしています。 |
| members | conversationMember コレクション | チャット内のすべてのメンバーのコレクション。 Null 許容型。 |
| messages | chatMessage コレクション | チャット内のすべてのメッセージのコレクション。 Null 許容型。 |
| operations | teamsAsyncOperation コレクション | チャットで実行された、または現在実行されているすべての Teams 非同期操作のコレクション。 Null 許容型。 |
| permissionGrants | resourceSpecificPermissionGrant コレクション | チャット用にアプリに付与されたアクセス許可のコレクション。 |
| pinnedMessages | pinnedChatMessageInfo コレクション | チャット内のピン留めされたすべてのメッセージのコレクション。 Null 許容型。 |
| tabs | teamsTab コレクション | チャット内のすべてのタブのコレクション。 Null 許容型。 |
| targetedMessages | targetedChatMessage コレクション | 特定のユーザーにのみ表示される、チャット内のターゲット メッセージのコレクション。 Null 許容型。
$expandを使用してこのリレーションシップを展開することはできません。 ターゲット メッセージは、 userTeamwork: getAllTargetedMessages API を使用して取得することもできます。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"chatType": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "String (timestamp)",
"migrationMode": "String",
"onlineMeetingInfo": {"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"},
"originalCreatedDateTime": "String (timestamp)",
"tenantId": "String",
"topic": "String",
"viewpoint": {"@odata.type": "microsoft.graph.chatViewpoint"},
"webUrl": "String"
}