チャット リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
1 人以上の参加者間の chatMessages のコレクションであるチャットを表します。 参加者には、ユーザーまたはアプリを指定できます。
注: チャットが onlineMeeting インスタンスに関連付けられている場合、一部のメソッドは会議に推移的に影響します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャット管理 | ||
| チャットを一覧表示する | チャット コレクション | ユーザーが参加しているチャットの一覧を取得します。 |
| チャットを作成する | チャット | 新しいチャットを作成します。 |
| チャットの取得 | チャット | チャットのプロパティとリレーションシップを読み取ります。 |
| チャットを更新する | チャット | チャットのプロパティを更新します。 |
| Delete | なし | チャットを削除します。 |
| ユーザーのすべてのアクセス権を削除する | なし | ユーザーのチャットへのアクセスを削除します。 |
| メンバーを一覧表示する | conversationMember コレクション | チャットのすべてのメンバーのリストを取得します。 |
| メンバーを追加する | Location ヘッダー | チャットにユーザーを追加します。 |
| メンバーを取得する | conversationMember | チャットの 1 人のユーザーを取得します。 |
| メンバーを削除する | なし | チャットからユーザーを削除します。 |
| ユーザーとアプリの間でチャットを行う | チャット | ユーザーとアプリの間で 1 対 1 のチャットを取得します。 |
| チャットを開封済みとしてマークする | なし | チャットをユーザーの読み取りとしてマークします。 |
| チャットを未読としてマークする | なし | チャットをユーザーの未読としてマークします。 |
| チャットを非表示にする | なし | ユーザーのチャットを非表示にします。 |
| チャットを再表示する | なし | ユーザーのチャットを再表示します。 |
| メッセージ | ||
| チャット内のメッセージを一覧表示する | 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 | String | チャットの一意の識別子。 読み取り専用です。 |
| isHiddenForAllMembers | ブール型 | すべてのメンバーに対してチャットが非表示かどうかを示します。 読み取り専用です。 |
| lastUpdatedDateTime | dateTimeOffset | チャットの名前が変更された日時、またはメンバーのリストが最後に変更された日時。 読み取り専用です。 |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | オンライン会議の詳細を表します。 チャットがオンライン会議に関連付けられていない場合、プロパティは空です。 読み取り専用です。 |
| tenantId | String | チャットが作成されたテナントの識別子。 読み取り専用です。 |
| topic | String | (省略可能)チャットの件名またはトピック。 グループ チャットでのみ使用できます。 |
| 見方 | chatViewpoint | 最後のメッセージの読み取り日時など、チャットに関する呼び出し元固有の情報を表します。 このプロパティは、委任されたコンテキストで要求が行われた場合にのみ設定されます。 |
| webUrl | String | Microsoft Teams内のチャットの URL。 URL は不透明な BLOB として扱われ、解析されません。 読み取り専用です。 |
chatType 値
| メンバー | 説明 |
|---|---|
| oneOnOne | チャットが 1 対 1 のチャットであることを示します。 名簿のサイズは、この種類のチャットに対して固定されています。メンバーを削除または追加することはできません。 |
| グループ | チャットがグループ チャットであることを示します。 この種類のチャットの名簿サイズ (少なくとも 2 人) を更新できます。 メンバーは後で削除または追加できます。 |
| 会議 | チャットがオンライン会議に関連付けられていることを示します。 この種類のチャットは、オンライン会議の作成の一部としてのみ作成されます。 |
| 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 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"chatType": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "string (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "String (timestamp)",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "String",
"topic": "String",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "String"
}