名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
指定した受信者にのみ表示されるMicrosoft Teams内のターゲット メッセージを表します。 グループ チャットまたはチャネルのすべての参加者に表示される通常のメッセージとは異なり、対象となるメッセージは、ユーザー固有の情報を必要とするボットの対話やアプリ間通信のプライバシーを提供します。
ターゲット メッセージは、次のようなシナリオで使用されます。
- 資格情報を要求するユーザーにのみ表示する必要がある、グループ コンテキストでのボット認証要求。
- 新しいメンバーのチャットの概要。参加メンバーにのみ表示されます。
- 機密性の高い情報またはユーザー固有の情報を含むプロアクティブおよびリアクティブなボット メッセージ。
chatMessage から継承します。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| 対象となるすべてのメッセージを取得する | targetedChatMessage コレクション | グループ チャットとチャネルで特定のユーザーに送信されたすべての ターゲット メッセージ を取得します。 |
| すべての保持対象メッセージを取得する | targetedChatMessage コレクション | グループ チャットとチャネルで特定のユーザーに送信されたすべての保持 対象メッセージ を取得します。 |
| チャネルのターゲット メッセージを削除する | なし | チャネル コンテキストから特定の ターゲット メッセージ を削除します。 |
| チャットの対象メッセージを削除する | なし | チャット コンテキストから特定 のターゲット メッセージ を削除します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| attachments | chatMessageAttachment コレクション | ファイル、タブ、会議、その他の項目などの添付オブジェクトへの参照。 chatMessage から継承されます。 |
| body | itemBody | メッセージの内容。 chatMessage から継承されます。 |
| channelIdentity | channelIdentity | ターゲット メッセージがチャネル コンテキストで送信された場合のチャネルとチームの情報。 channelId プロパティと teamId プロパティが含まれます。 chatMessage から継承されます。 |
| chatId | 文字列 | 対象のメッセージがグループ チャット コンテキストで送信された場合のチャットの一意識別子。 chatMessage から継承されます。 |
| createdDateTime | DateTimeOffset | メッセージが作成された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
chatMessage から継承されます。 |
| deletedDateTime | DateTimeOffset | メッセージが削除された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 保持されたメッセージにのみ適用されます。
chatMessage から継承されます。 |
| etag | 文字列 | メッセージのバージョン番号。 chatMessage から継承されます。 |
| eventDetail | eventMessageDetail | このメッセージがシステム イベントを表す場合のイベントの詳細。 chatMessage から継承されます。 |
| from | chatMessageFromIdentitySet | 対象メッセージの送信者に関する詳細。 chatMessage から継承されます。 |
| id | 文字列 | メッセージの一意識別子。 メッセージ ID は、特定のユーザーの 1 つの会話 (チャットまたはチャネル) のコンテキスト内でのみ一意です。 chatMessage から継承されます。 |
| importance | chatMessageImportance | メッセージの重要度です。 使用可能な値: normal、high、urgent。
chatMessage から継承されます。 |
| lastEditedDateTime | DateTimeOffset | メッセージが最後に編集された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
chatMessage から継承されます。 |
| lastModifiedDateTime | DateTimeOffset | メッセージまたはそのプロパティのいずれかが最後に変更された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。
chatMessage から継承されます。 |
| ロケール | 文字列 |
en-us形式のクライアントによって設定されたメッセージのロケール。
chatMessage から継承されます。 |
| mentions | chatMessageMention コレクション | メッセージに記載されているエンティティの一覧。 chatMessage から継承されます。 |
| messageHistory | chatMessageHistoryItem コレクション | メッセージに適用された編集の履歴。 chatMessage から継承されます。 |
| messageType | chatMessageType | メッセージの種類。 使用可能な値: message、chatEvent、typing、unknownFutureValue、systemEventMessage。
Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型から次の値を取得します:systemEventMessage。
chatMessage から継承されます。 |
| onBehalfOf | chatMessageFromIdentitySet | メッセージが送信されたユーザーに関する情報。 chatMessage から継承されます。 |
| policyViolation | chatMessagePolicyViolation | データ損失防止 (DLP) アプリケーションによってメッセージに適用されるポリシー違反に関する情報。 chatMessage から継承されます。 |
| reactions | chatMessageReaction コレクション | メッセージに適用される反応 (例: ハート、笑)。 chatMessage から継承されます。 |
| 受信者 | identity | 対象メッセージの目的の受信者。 |
| replyToId | 文字列 | スレッドの親メッセージまたはルート メッセージの ID。 chatMessage から継承されます。 |
| subject | String | メッセージの件名。 chatMessage から継承されます。 |
| 概要 | 文字列 | 通知または概要ビューに使用できるメッセージの概要テキスト。 chatMessage から継承されます。 |
| webUrl | String | Microsoft Teamsのメッセージへのリンク。 chatMessage から継承されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| hostedContents | chatMessageHostedContent コレクション | 画像やコード スニペットなど、メッセージでホストされるコンテンツ。 chatMessage から継承されます。 |
| 返信 | chatMessage コレクション | メッセージに応答します。 現在、ターゲット メッセージではサポートされていません。 chatMessage から継承されます。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.targetedChatMessage",
"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"}],
"recipient": {"@odata.type": "microsoft.graph.identity"},
"replyToId": "String",
"subject": "String",
"summary": "String",
"webUrl": "String"
}