チャット リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

チャットは、1 人以上の参加者間 の chatMessages のコレクションです。 参加者は、ユーザーまたはアプリにすることができます。

注: チャットが onlineMeeting インスタンスに関連付けられている場合、一覧に示されている方法の一部は会議に推移的に影響します。

メソッド

メソッド	戻り値の型	説明
チャット管理
チャットを一覧表示する	チャット コレクション	ユーザーが参加しているチャットの一覧を取得します。
チャットを作成する	チャット	新しいチャットを作成します。
チャットの取得	チャット	チャットのプロパティとリレーションシップを読み取ります。
チャットを更新する	チャット	チャットのプロパティを更新します。
チャットのメンバーを一覧表示する	conversationMember コレクション	チャットのすべてのメンバーのリストを取得します。
チャットのメンバーを追加する	Location ヘッダー	チャットにユーザーを追加します。
チャットのメンバーを取得する	conversationMember	チャットの 1 人のユーザーを取得します。
チャットのメンバーを削除する	なし	チャットからユーザーを削除します。
ユーザーとアプリの間でチャットを行う	チャット	ユーザーとアプリの間で 1 対 1 のチャットを行います。
チャットを読み取りとしてマークする	なし	チャットをユーザーの読み取りとしてマークします。
チャットを未読としてマークする	None	チャットをユーザーの未読としてマークします。
チャットを非表示にする	None	ユーザーのチャットを非表示にします。
チャットの再表示	None	ユーザーのチャットを再表示します。
メッセージ
チャットでメッセージを一覧表示する	chatMessage	チャットでメッセージを取得します。
チャット内のメッセージを取得する	chatMessage	チャット内の 1 つのメッセージを取得します。
ユーザーのすべてのチャットでメッセージを取得する	チャット コレクション	ユーザーが参加しているすべてのチャットからメッセージを取得します。
アプリ
チャットのアプリを一覧表示する	teamsAppInstallation コレクション	チャット (および関連する会議) にインストールされているアプリを一覧表示します。
チャットでアプリを取得する	teamsAppInstallation	チャット (および関連する会議) にインストールされている特定のアプリを取得します。
チャットでアプリを追加する		チャット (および関連する会議) にアプリを追加 (インストール) します。
チャットでアプリをアップグレードする	None	チャット (および関連する会議) にインストールされているアプリの最新バージョンに更新します。
チャットからアプリをアンインストールする	None	チャット (および関連する会議) からアプリを削除 (アンインストール) します。
権限付与の表示	resourceSpecificPermissionGrant コレクション	このチャットのアプリに付与されているアクセス許可を一覧表示します。
タブ
チャットでタブを一覧表示する	teamsTab	チャット (および関連する会議) にピン留めされたタブを一覧表示します。
チャットでタブを取得する	teamsTab	チャット (および関連する会議) にピン留めされた特定のタブを取得します。
チャットにタブを追加する	teamsTab	チャット (および関連する会議) にタブを追加 (ピン留め) します。
チャットの [更新] タブ	teamsTab	チャット (および関連する会議) のタブのプロパティを更新します。
チャットからタブを削除する	None	チャット (および関連する会議) からタブを削除 (固定解除) します。
操作
チャットでの操作の一覧表示	teamsAsyncOperation コレクション	チャットで実行または実行されている非同期操作の一覧を取得します。
チャットで操作を取得する	teamsAsyncOperation	チャットで実行または実行されている 1 つの非同期操作を取得します。
ピン留めされたメッセージ
ピン留めされたメッセージを一覧表示する	pinnedChatMessageInfo コレクション	チャットでピン留めされたメッセージの一覧を取得します。
メッセージをピン留めする	pinnedChatMessageInfo	チャットにチャット メッセージをピン留めします。
メッセージのピン留めを解除する	None	チャットからメッセージの固定を解除します。

メモ： アプリケーションのアクセス許可を使用する場合は、チャット ID を取得する方法を確認してください。 アプリケーションのアクセス許可を持つチャットの一覧表示はサポートされていないため、すべてのシナリオが可能なわけではありません。 委任されたアクセス許可を持つチャット ID、およびアプリケーションのアクセス許可を持つ /chats/getAllMessages の変更通知 から取得できます。

プロパティ

プロパティ	型	説明
chatType	chatType	チャットの種類を指定します。 使用可能な値: group、oneOnOne、meeting、unknownFutureValue。
createdDateTime	dateTimeOffset	チャットが作成された日時。 読み取り専用です。
id	String	チャットの一意の識別子。 読み取り専用です。
lastUpdatedDateTime	dateTimeOffset	チャットの名前が変更された日時、またはメンバーの一覧が最後に変更された日時。 読み取り専用です。
onlineMeetingInfo	teamworkOnlineMeetingInfo	オンライン会議の詳細を表します。 チャットがオンライン会議に関連付けられていない場合、プロパティは空です。 読み取り専用です。
tenantId	String	チャットが作成されたテナントの識別子。 読み取り専用です。
topic	String	(省略可能)チャットの件名またはトピック。 グループ チャットでのみ使用できます。
視点	chatViewpoint	最後のメッセージ読み取り日時など、チャットに関する呼び出し元固有の情報を表します。 このプロパティは、委任されたコンテキストで要求が行われた場合にのみ設定されます。
webUrl	String	Microsoft Teams のチャットの URL。 URL は不透明な BLOB として扱われ、解析されません。 読み取り専用です。

chatType 値

メンバー	値	説明
oneOnOne	0	チャットが 1 対 1 のチャットであることを示します。 この種類のチャットでは、名簿のサイズが固定されています。メンバーを削除/追加することはできません。
グループ	1	チャットがグループ チャットであることを示します。 この種類のチャットでは、名簿のサイズ (少なくとも 2 人) を更新できます。 メンバーは後で削除/追加できます。
会議	2	チャットがオンライン会議に関連付けられていることを示します。 この種類のチャットは、オンライン会議の作成の一環としてのみ作成されます。
unknownFutureValue	3	進化可能な列挙センチネル値。 使用しないでください。

リレーションシップ

リレーションシップ	型	説明
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 表記を次に示します。

{
  "id": "string (identifier)",
  "topic": "string",
  "createdDateTime": "dateTimeOffset",
  "lastUpdatedDateTime": "dateTimeOffset",
  "chatType": "string",
  "webUrl": "string",
  "tenantId": "string",
  "viewpoint": {
    "@odata.type": "microsoft.graph.chatViewpoint"
  },
  "onlineMeetingInfo": {
    "@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
  }
}

関連項目

• チャネル
• chatMessage