chatMessage リソースの種類

[アーティクル]
04/18/2024

名前空間: microsoft.graph

重要

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

チャネルまたはチャット内の個別のチャットメッセージを表します。メッセージは、ルートメッセージまたはメッセージの中の replyToId プロパティに定義されているスレッドの一部にすることができます。

注: このリソースは、変更通知を使用した変更のサブスクライブ (作成、更新、削除) をサポートします。これにより、発信者はサブスクライブして変更をリアルタイムで取得できます。詳細については、「メッセージの通知を取得する」を参照してください。

メソッド

メソッド	戻り値の型	説明
チャネルメッセージ
チャネル内のメッセージを一覧表示する	chatMessage コレクション	チャネル内のすべてのルートメッセージの一覧。
チャネル内のメッセージの差分を取得する	chatMessage	チャネルの増分メッセージを取得します。
新しいチャネルメッセージのサブスクリプションを作成する	subscription	新しいメッセージ、編集済みメッセージ、削除されたメッセージ、およびそれらに対するリアクションをリッスンします。
チャネルでメッセージを取得する	chatMessage	チャネルで 1 つのルートメッセージを取得します。
チャネルでメッセージを送信する	chatMessage	チャネルに新しいルートメッセージを作成します。
チャネルでメッセージを更新する	なし	チャットメッセージのプロパティを更新します。
チャネル内のメッセージを削除する	なし	チャネル内のメッセージを削除します。
チャネル内のメッセージの削除を元に戻す	なし	チャネル内のメッセージの削除を取り消します。
チャネル内のメッセージへのリアクションを設定する	なし	チャネル内のメッセージに対するリアクションを設定します。
チャネル内のメッセージに対する反応の設定を解除する	なし	チャネル内のメッセージに対する反応の設定を解除します。
チャネルメッセージ応答
メッセージへの応答を一覧表示する	chatMessage コレクション	チャネル内のチャットメッセージに対するすべての応答の一覧。
チャネルで返信メッセージを取得する	chatMessage	チャネルで 1 つの応答メッセージを取得します。
チャネル内のメッセージに返信する	chatMessage	チャネル内の既存のチャットメッセージに返信します。
返信メッセージを更新する	chatMessage	チャットメッセージのプロパティを更新します。
チャネルで返信メッセージを削除する	chatMessage	チャネル内の 1 つの応答メッセージを削除します。
チャネル内の応答メッセージの削除を元に戻す	chatMessage	チャネル内の 1 つの応答メッセージの削除を取り消します。
チャネル内の応答メッセージに対するリアクションを設定する	chatMessage	チャネル内の応答メッセージに対するリアクションを設定します。
チャネル内の応答メッセージに対する反応の設定を解除する	chatMessage	チャネル内の応答メッセージに対する反応の設定を解除します。
チャットのメッセージ
チャットでメッセージを一覧表示する	chatMessage	チャット内のチャットメッセージを一覧表示します。
チャット内のメッセージを取得する	chatMessage	チャットで 1 つのチャットメッセージを取得します。
ユーザーのすべてのチャットでメッセージを取得する	チャットコレクション	1 対 1 のチャット、グループチャット、会議チャットなど、ユーザーが参加しているすべてのチャットからメッセージを取得します。
全チャネルメッセージ取得 API が追加されました	channel コレクション	ユーザーが参加しているすべてのチャネルからすべてのメッセージを取得します。
新しいチャットメッセージのサブスクリプションを作成する	subscription	新しいチャットメッセージ、編集メッセージ、削除されたチャットメッセージ、およびそれらに対するリアクションをリッスンします。
チャットでメッセージを送信する	chatMessage	既存の 1:1 またはグループチャット会話でチャットメッセージを送信します。
チャット内のメッセージを更新する	chatMessage	チャットメッセージのプロパティを更新します。
チャットでメッセージを削除する	chatMessage	チャットのメッセージを削除します。
チャット内のメッセージの削除を元に戻す	chatMessage	チャットでメッセージの削除を取り消します。
チャット内のメッセージに対するリアクションを設定する	chatMessage	チャット内のメッセージに対するリアクションを設定します。
チャット内のメッセージに対する反応の設定を解除する	chatMessage	チャット内のメッセージに対する反応の設定を解除します。
ホストされるコンテンツ
すべてのホストされているコンテンツを一覧表示する	chatMessageHostedContent コレクション	メッセージに関連付けられているホストされているすべてのコンテンツを取得します。
ホストされているコンテンツを取得する	chatMessageHostedContent	メッセージのホストされたコンテンツ (およびそのバイト) を取得します。

プロパティ

プロパティ	型	説明
attachments	chatMessageAttachment コレクション	ファイル、タブ、会議などの添付オブジェクトへの参照。
body	itemBody	チャットメッセージのコンテンツのプレーンテキスト/HTML 表現。表記は、本文内の contentType によって指定されます。チャットメッセージに chatMessageMention が含まれている場合、コンテンツは常に HTML 形式になります。
channelIdentity	channelIdentity	メッセージがチャネルで送信された場合は、チャネルの ID を表します。
chatId	string	メッセージがチャットで送信された場合は、チャットの ID を表します。
createdDateTime	dateTimeOffset	チャットメッセージが作成されたときのタイムスタンプ。
deletedDateTime	dateTimeOffset	読み取り専用です。チャットメッセージが削除されたタイムスタンプ。削除されていない場合は null。
etag	string	読み取り専用です。チャットメッセージのバージョン番号。
eventDetail	eventMessageDetail	読み取り専用。存在する場合は、チャット、チャネル、またはチームで発生したイベントの詳細 (たとえば、新しいメンバーの追加) を表します。イベントメッセージの場合、 messageType プロパティはに `systemEventMessage`設定されます。
from	chatMessageFromIdentitySet	チャットメッセージの送信者の詳細。移行中にのみ設定できます。
id	String	読み取り専用です。メッセージの一意の ID。 ID はチャット/チャネル/メッセージへの返信内で一意ですが、他のチャット/チャネル/返信メッセージで重複している可能性があります。
importance	string	チャットメッセージの重要性。使用可能な値: `normal`、`high`、`urgent`。
lastEditedDateTime	dateTimeOffset	読み取り専用です。チャットメッセージの編集が行われた場合のタイムスタンプ。 Teams UI で "編集済み" フラグをトリガーします。編集が行われなかった場合、値はです `null`。
lastModifiedDateTime	dateTimeOffset	読み取り専用です。チャットメッセージが作成または変更されたとき (リアクションが追加または削除されたときなど) のタイムスタンプ。
locale	string	クライアントによって設定されたチャットメッセージのロケール。常に `en-us` に設定します。
mentions	chatMessageMention コレクション	チャットメッセージに記載されているエンティティの一覧。サポートされているエンティティは、ユーザー、ボット、チーム、チャネル、タグです。
messageHistory	chatMessageHistoryItem コレクション	メッセージ項目のアクティビティ履歴の一覧。メッセージに対する変更時間とアクション (reactionAdded、reactionRemoved、リアクションの変更など)。
messageType	chatMessageType	チャットメッセージの種類。使用可能な値: `message`、`chatEvent`、`typing`、`unknownFutureValue`、`systemEventMessage`。この進化可能な列挙型で次の値を取得するには、`Prefer: include-unknown-enum-members` 要求ヘッダーを使用する必要があることに注意してください: `systemEventMessage`。
onBehalfOf	chatMessageFromIdentitySet	ボットがユーザーに代わってメッセージを送信するときのメッセージのユーザー属性。
policyViolation	chatMessagePolicyViolation	データ損失防止 (DLP) アプリケーションによって設定されるポリシー違反のプロパティを定義します。
reactions	chatMessageReaction コレクション	このチャットメッセージに対するリアクション (例: Like)。
replyToId	string	読み取り専用です。スレッドの親チャットメッセージまたはルートチャットメッセージの ID。 (チャネル内のチャットメッセージにのみ適用され、チャットには適用されません)。
subject	string	プレーンテキストでのチャットメッセージの件名。
summary	string	プッシュ通知とサマリービューまたはフォールバックビューに使用できるチャットメッセージの概要テキスト。チャネルチャットメッセージにのみ適用され、チャット内のチャットメッセージには適用されません。
webUrl	string	読み取り専用です。 Microsoft Teams のメッセージにリンクします。

リレーションシップ

リレーションシップ	型	説明
返信	chatMessage コレクション	指定したメッセージの応答。チャネルメッセージの `$expand` サポート。
hostedContents	chatMessageHostedContent コレクション	Microsoft Teams によってホストされるメッセージ内のコンテンツ (画像やコードスニペットなど)。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "attachments": [{"@odata.type": "microsoft.graph.chatMessageAttachment"}],
  "body": {"@odata.type": "microsoft.graph.itemBody"},
  "channelIdentity": {"@odata.type": "microsoft.graph.channelIdentity"},
  "chatId": "String",
  "createdDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "etag": "String",
  "eventDetail": {"@odata.type": "microsoft.graph.eventMessageDetail"},
  "from": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
  "id": "String (identifier)",
  "importance": "String",
  "lastEditedDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "locale": "String",
  "mentions": [{"@odata.type": "microsoft.graph.chatMessageMention"}],
  "messageHistory": [{"@odata.type": "microsoft.graph.chatMessageHistoryItem"}],
  "messageType": "String",
  "onBehalfOf": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
  "policyViolation": {"@odata.type": "microsoft.graph.chatMessagePolicyViolation"},
  "reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
  "replyToId": "String (identifier)",
  "subject": "String",
  "summary": "String",
  "webUrl": "String"
}