chatMessage リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
チャネルまたはチャット内の個別のチャット メッセージを表します。 メッセージは、ルート メッセージまたはメッセージの中の replyToId プロパティに定義されているスレッドの一部にすることができます。
注: このリソースは、変更 通知を使用した変更のサブスクライブ (作成、更新、削除) をサポートします。 これにより、発信者はサブスクライブして変更をリアルタイムで取得できます。 詳細については、「メッセージの通知を取得する」を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャネル メッセージ | ||
| チャネル内のメッセージを一覧表示する | chatMessage コレクション | チャネル内のすべてのルート メッセージの一覧。 |
| チャネル内のメッセージの差分を取得する | chatMessage | チャネルの増分メッセージを取得します。 |
| 新しいチャネル メッセージのサブスクリプションを作成する | subscription | 新しいメッセージ、編集済みメッセージ、削除されたメッセージ、およびメッセージに対する反応をリッスンします。 |
| チャネルでメッセージを取得する | chatMessage | チャネルで 1 つのルート メッセージを取得します。 |
| チャネルでメッセージを送信する | chatMessage | チャネルに新しいルート メッセージを作成します。 |
| チャネル内のメッセージを更新する | chatMessage | チャット メッセージの policyViolation プロパティを更新します。 |
| チャネル内のメッセージを削除する | chatMessage | チャネル内のメッセージを削除します。 |
| チャネル内のメッセージの削除を元に戻す | chatMessage | チャネル内のメッセージの削除を解除します。 |
| チャネル メッセージの返信 | ||
| メッセージへの返信を一覧表示する | chatMessage コレクション | チャネル内のチャット メッセージに対するすべての返信の一覧。 |
| チャネルで応答メッセージを取得する | chatMessage | チャネルで 1 つの応答メッセージを取得します。 |
| チャネル内のメッセージに返信する | chatMessage | チャネル内の既存のチャット メッセージに返信します。 |
| 応答メッセージを更新する | chatMessage | チャット メッセージの policyViolation プロパティを更新します。 |
| チャネル内の応答メッセージを削除する | chatMessage | チャネル内の 1 つの応答メッセージを削除します。 |
| チャネル内の応答メッセージの削除を元に戻す | chatMessage | チャネル内の単一の応答メッセージの削除を解除します。 |
| チャットのメッセージ | ||
| チャットでメッセージを一覧表示する | chatMessage | チャット内のチャット メッセージを一覧表示します。 |
| チャット内のメッセージを取得する | chatMessage | チャットで 1 つのチャット メッセージを取得します。 |
| ユーザーのすべてのチャットでメッセージを取得する | チャット コレクション | 1 対 1 のチャット、グループ チャット、会議チャットなど、ユーザーが参加しているすべてのチャットからメッセージを取得します。 |
| 全チャネル メッセージ取得 API が追加されました | channel コレクション | ユーザーが参加しているすべてのチャネルからすべてのメッセージを取得します。 |
| 新しいチャット メッセージのサブスクリプションを作成する | subscription | 新しいチャット メッセージ、編集済みメッセージ、削除されたチャット メッセージ、およびそれらに対する反応を聞きます。 |
| チャットでメッセージを送信する | chatMessage | 既存の 1 対 1 またはグループ チャット会話でチャット メッセージを送信します。 |
| チャットでメッセージを更新する | chatMessage | チャット メッセージの policyViolation プロパティを更新します。 |
| チャットでメッセージを削除する | chatMessage | チャットのメッセージを削除します。 |
| チャットでメッセージの削除を元に戻す | chatMessage | チャットでメッセージの削除を解除します。 |
| ホストされたコンテンツ | ||
| すべてのホストされているコンテンツを一覧表示する | chatMessageHostedContent コレクション | メッセージに関連付けられているすべてのホストコンテンツを取得します。 |
| ホストされているコンテンツを取得する | chatMessageHostedContent | メッセージのホストされたコンテンツ (およびそのバイト) を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| attachments | chatMessageAttachment コレクション | ファイル、タブ、会議などの添付オブジェクトへの参照。 |
| body | itemBody | チャット メッセージのコンテンツのプレーンテキスト/HTML 表現。 表記は、本文内の contentType によって指定されます。 チャット メッセージに chatMessageMention が含まれている場合、コンテンツは常に HTML で表示されます。 |
| channelIdentity | channelIdentity | メッセージがチャネルで送信された場合は、チャネルの ID を表します。 |
| chatId | 文字列 | メッセージがチャットで送信された場合は、 チャット の ID を表 します。 |
| createdDateTime | dateTimeOffset | チャット メッセージが作成された日時のタイムスタンプ。 |
| deletedDateTime | dateTimeOffset | 読み取り専用です。 チャット メッセージが削除されたタイムスタンプ。削除されていない場合は null。 |
| etag | string | 読み取り専用です。 チャット メッセージのバージョン番号。 |
| eventDetail | eventMessageDetail | 読み取り専用です。 存在する場合は、新しいメンバーの追加など、 チャット、 チャネル、または チーム で発生したイベントの詳細を表します。 イベント メッセージの場合、 messageType プロパティは systemEventMessage. |
| from | chatMessageFromIdentitySet | チャット メッセージの送信者の詳細。 移行中にのみ設定できます。 |
| id | String | 読み取り専用です。 メッセージの一意の ID。 |
| importance | string | チャット メッセージの重要性。 使用可能な値: normal、high、urgent。 |
| lastEditedDateTime | dateTimeOffset | 読み取り専用です。 チャット メッセージの編集が行われたタイムスタンプ。 Teams UI で "編集済み" フラグをトリガーします。 編集が行われなければ、値は null. |
| lastModifiedDateTime | dateTimeOffset | 読み取り専用です。 チャット メッセージが作成されたとき (初期設定) または変更されたとき (反応が追加または削除された場合を含む) タイムスタンプ。 |
| locale | string | クライアントによって設定されたチャット メッセージのロケール。 常に en-us に設定します。 |
| mentions | chatMessageMention コレクション | チャット メッセージに記載されているエンティティの一覧。 サポートされるエンティティは、ユーザー、ボット、チーム、チャネル、タグです。 |
| 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 表記を次に示します。
{
"id": "string (identifier)",
"replyToId": "string (identifier)",
"from": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
"etag": "string",
"messageType": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"lastEditedDateTime": "string (timestamp)",
"deletedDateTime": "string (timestamp)",
"subject": "string",
"body": {"@odata.type": "microsoft.graph.itemBody"},
"summary": "string",
"attachments": [{"@odata.type": "microsoft.graph.chatMessageAttachment"}],
"mentions": [{"@odata.type": "microsoft.graph.chatMessageMention"}],
"onBehalfOf": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
"importance": "string",
"reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
"locale": "string",
"policyViolation": {"@odata.type": "microsoft.graph.chatMessagePolicyViolation"},
"chatId": "string",
"channelIdentity": {"@odata.type": "microsoft.graph.channelIdentity"},
"webUrl": "string",
"eventDetail": {
"@odata.type": "microsoft.graph.eventMessageDetail"
}
}
フィードバック
フィードバックの送信と表示