名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
チャネルまたはチャット内の個別のチャット メッセージを表します。 メッセージは、ルート メッセージまたはメッセージの中の replyToId プロパティに定義されているスレッドの一部にすることができます。
targetedChatMessage リソースは、指定された受信者にのみ表示される特殊な種類のチャット メッセージです。 詳細については、「 targetedChatMessage」を参照してください。
注: このリソースでは 、変更通知を使用した変更のサブスクライブ (作成、更新、削除) がサポートされています。 これにより、発信者はサブスクライブして変更をリアルタイムで取得できます。 詳細については、「メッセージの通知を取得する」を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャネル メッセージ | ||
| チャネルでメッセージを一覧表示する | chatMessage コレクション | チャネル内のすべてのルート メッセージの一覧。 |
| 新しいチャネル メッセージのサブスクリプションを作成する | subscription | 新しいメッセージ、編集されたメッセージ、削除されたメッセージ、およびそれらに対する反応を聞き取ります。 |
| チャネルでメッセージを取得する | chatMessage | チャネルで単一のルート メッセージを取得します。 |
| チャネルでメッセージを送信する | 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 | チャット内のメッセージに対する未設定のリアクション。 |
| チャットにメッセージを転送する | forwardToChatResult コレクション | チャット メッセージ、チャネル メッセージ、またはチャネル メッセージ返信をチャットに転送します。 |
| 引用符付きで返信する | chatMessage | チャット内の 1 つのチャット メッセージまたは複数のチャット メッセージに引用符付きで返信します。 |
| ホストされるコンテンツ | ||
| すべてのホストされているコンテンツを一覧表示する | chatMessageHostedContent コレクション | メッセージに関連付けられているすべてのホストされているコンテンツを取得します。 |
| ホストされているコンテンツを取得する | chatMessageHostedContent | メッセージのホストされているコンテンツ (およびそのバイト) を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| attachments | chatMessageAttachment コレクション | ファイル、タブ、会議などの添付オブジェクトへの参照 |
| body | chatMessageBody | チャット メッセージのコンテンツのプレーンテキスト/HTML/マークダウン表現。 表現は、本文内の messageBodyContentType (または非推奨の 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 | chatMessageImportance | メッセージの重要度です。 使用可能な値: normal、high、urgent、unknownFutureValue。 |
| 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 コレクション | このチャット メッセージに対するリアクション (たとえば、いいね! など)。 |
| 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.chatMessageBody"},
"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"
}