chatMessage リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
チャネルまたはチャット内の個別のチャット メッセージを表します。 メッセージは、ルート メッセージまたはメッセージの中の replyToId プロパティに定義されているスレッドの一部にすることができます。
注: このリソースは、変更通知を使用した変更のサブスクライブ (作成、更新、削除) をサポートします。 これにより、発信者はサブスクライブして変更をリアルタイムで取得できます。 詳細については、「メッセージの通知を取得する」を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャネル メッセージ | ||
| チャネルでメッセージを一覧表示する | chatMessage コレクション | チャネル内のすべてのルート メッセージの一覧。 |
| 新しいチャネル メッセージのサブスクリプションを作成する | subscription | 新しいメッセージ、編集済みメッセージ、削除されたメッセージ、およびそれらに対するリアクションをリッスンします。 |
| チャネルでメッセージを取得する | chatMessage | チャネルで 1 つのルート メッセージを取得します。 |
| チャネルでメッセージを送信する | chatMessage | チャネルに新しいルート メッセージを作成します。 |
| チャネルでメッセージを更新する | なし | チャット メッセージのプロパティを更新します。 |
| チャネルでメッセージを削除する | なし | チャネル内のメッセージを削除します。 |
| チャネルでメッセージの削除を元に戻す | なし | チャネル内のメッセージの削除を取り消します。 |
| チャネルでメッセージへのリアクションを設定する | なし | チャネル内のメッセージに対するリアクションを設定します。 |
| チャネルでメッセージへのリアクションの設定を解除する | なし | チャネル内のメッセージに対する反応の設定を解除します。 |
| チャネル メッセージの返信 | ||
| メッセージへの返信を一覧表示する | chatMessage コレクション | チャネル内のチャット メッセージに対するすべての応答の一覧。 |
| チャネルで返信メッセージを取得する | chatMessage | チャネルで 1 つの応答メッセージを取得します。 |
| チャネルでメッセージに返信する | chatMessage | チャネル内の既存のチャット メッセージに返信します。 |
| 返信メッセージを更新する | chatMessage | チャット メッセージのプロパティを更新します。 |
| チャネルで返信メッセージを削除する | chatMessage | チャネル内の 1 つの応答メッセージを削除します。 |
| チャネルで返信メッセージの削除を元に戻す | chatMessage | チャネル内の 1 つの応答メッセージの削除を取り消します。 |
| チャネル内の応答メッセージに対するリアクションを設定する | chatMessage | チャネル内の応答メッセージに対するリアクションを設定します。 |
| チャネル内の応答メッセージに対する反応の設定を解除する | chatMessage | チャネル内の応答メッセージに対する反応の設定を解除します。 |
| チャットのメッセージ | ||
| チャットでメッセージを一覧表示する | chatMessage | チャット内のチャット メッセージを一覧表示します。 |
| チャット内のメッセージを取得する | chatMessage | チャットで 1 つのチャット メッセージを取得します。 |
| ユーザーのすべてのチャットでメッセージを取得する | チャット コレクション | 1 対 1 のチャット、グループ チャット、会議チャットなど、ユーザーが参加しているすべてのチャットからメッセージを取得します。 |
| ユーザーのデルタ チャット メッセージを取得する | chatMessage コレクション | 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"
}