chatMessage リソースの種類chatMessage resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

チャネルまたはチャット内の個別のチャット メッセージを表します。Represents an individual chat message within a channel or chat. チャットメッセージは、ルートチャットメッセージ、またはチャットメッセージのreplyToIdプロパティで定義されている応答スレッドの一部にすることができます。The chat message can be a root chat message or part of a reply thread that is defined by the replyToId property in the chat message.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
チャネルチャットメッセージの一覧表示List channel chatMessage chatMessage コレクションchatMessage collection チャネル内のすべてのルートチャットメッセージのリスト。List of all root chat messages in a channel.
チャネルデルタで chatMessages を取得するGet chatMessages in a channel delta chatMessagechatMessage チャネル内の増分チャットメッセージを取得します。Get incremental chat messages in a channel.
チャネルのチャットメッセージを取得するGet channel chatMessage chatMessagechatMessage チャネルから1つのルートチャットメッセージを取得します。Get a single root chat message from a channel.
ChatMessage への返信を一覧表示するList replies to a chatMessage chatMessage コレクションchatMessage collection チャネル内のチャットメッセージへのすべての返信の一覧。List of all replies to a chat message in channel.
ChatMessage への返信を取得するGet a reply to a chatMessage chatMessagechatMessage チャネル内のチャットメッセージに対して1回の返信を取得します。Get a single reply to a chat message in a channel.
チャネルでの chatMessage の作成Create chatMessage in a channel chatMessagechatMessage チャネルに新しいトップレベルチャットメッセージを作成します。Create a new top-level chat message in a channel.
チャネル内の chatMessage に返信するReply to a chatMessage in a channel chatMessagechatMessage チャネル内の既存のチャットメッセージに返信します。Reply to an existing chat message in a channel.
チャットでの chatMessage の作成Create chatMessage in a chat chatMessagechatMessage 既存の1:1 またはグループチャットの会話でチャットメッセージを送信します。Send a chat message in an existing 1:1 or group chat conversation.
チャットのチャットメッセージを一覧表示するList chatMessages in a chat chatMessagechatMessage チャットメッセージを1:1 またはグループチャットで一覧表示します。List chat messages in a 1:1 or group chat.
チャットでの chatMessage の取得Get chatMessage in chat chatMessagechatMessage チャットで1つのチャットメッセージを取得します。Get a single chat message in a chat.
ホストされているすべての画像を一覧表示するList all hosted images HostedimageコレクションhostedImage collection チャットメッセージ内のすべてのホストされた画像を取得します。Get all hosted images in a chat message.
ホストされた画像を取得するGet hosted image hostedImagehostedImage チャットメッセージからホストされているイメージを取得します。Get a hosted image from a chat message.
ホストされた画像バイトを取得するGet hosted image bytes バイナリイメージデータbinary image data チャットメッセージからホストされているイメージのバイナリイメージデータを取得します。Get binary image data of a hosted image from a chat message.

プロパティProperties

プロパティProperty Type 説明Description
idid StringString 読み取り専用。Read-only. メッセージの一意の Id。Unique Id of the message.
replyToIdreplyToId stringstring 読み取り専用です。Read-only. スレッドの親チャットメッセージまたはルートチャットメッセージの Id。Id of the parent chat message or root chat message of the thread. (チャットではないチャネルのチャットメッセージにのみ適用されます)(Only applies to chat messages in channels not chats)
fromfrom identitySetidentitySet 読み取り専用です。Read only. チャットメッセージの送信者の詳細。Details of the sender of the chat message.
etagetag stringstring 読み取り専用です。Read-only. チャットメッセージのバージョン番号。Version number of the chat message.
messageTypemessageType chatMessageTypechatMessageType チャットメッセージの種類。The type of chat message. 使用可能な値はmessage次のとおりです。The possible values are: message.
createdDateTimecreatedDateTime dateTimeOffsetdateTimeOffset 読み取り専用です。Read only. チャットメッセージが作成された時点のタイムスタンプ。Timestamp of when the chat message was created.
lastModifiedDateTimelastModifiedDateTime dateTimeOffsetdateTimeOffset 読み取り専用です。Read only. チャットメッセージが作成または編集されたときのタイムスタンプ (チャネルでのルートチャットメッセージの場合)、または反応が追加または削除されたとき。Timestamp of when the chat message is created or edited, including when a reply is made (if it's a root chat message in a channel) or a reaction is added or removed.
deletedDateTimedeletedDateTime dateTimeOffsetdateTimeOffset 読み取り専用です。Read only. チャットメッセージが削除されたタイムスタンプ、または削除されていない場合は null。Timestamp at which the chat message was deleted, or null if not deleted.
subjectsubject stringstring テキスト形式のチャットメッセージの件名。The subject of the chat message, in plaintext.
bodybody itemBodyitemBody チャットメッセージの内容をプレーンテキストまたは HTML で表したものです。Plaintext/HTML representation of the content of the chat message. 表記は、本文内の contentType によって指定されます。Representation is specified by the contentType inside the body. チャットメッセージにchatMessageMentionが含まれている場合、コンテンツは常に HTML 形式です。The content is always in HTML if the chat message contains a chatMessageMention.
summarysummary stringstring プッシュ通知および要約ビューに使用したり、ビューに戻したりすることができるチャットメッセージの概要テキスト。Summary text of the chat message that could be used for push notifications and summary views or fall back views. チャットのチャットメッセージではなく、チャネルチャットメッセージのみに適用されます。Only applies to channel chat messages, not chat messages in a chat.
attachmentsattachments chatMessageAttachment コレクションchatMessageAttachment collection 添付ファイル。Attached files. 添付ファイルは現在読み取り専用です。添付ファイルの送信はサポートされていません。Attachments are currently read-only – sending attachments is not supported.
mentionsmentions chatMessageMention コレクションchatMessageMention collection チャットメッセージで言及されているエンティティのリスト。List of entities mentioned in the chat message. 現在、user、bot、team、channel がサポートされています。Currently supports user, bot, team, channel.
importanceimportance chatMessageImportance 度chatMessageImportance チャットメッセージの重要度。The importance of the chat message. 使用可能な値: normalhighurgentThe possible values are: normal, high, urgent.
reactionsreactions chatMessageReaction コレクションchatMessageReaction collection このチャットメッセージの反応 (たとえば、など)。Reactions for this chat message (for example, Like).
localelocale stringstring クライアントによって設定されたチャットメッセージのロケール。Locale of the chat message set by the client.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

{
  "id": "string (identifier)",
  "replyToId": "string (identifier)",
  "from": {"@odata.type": "microsoft.graph.identitySet"},
  "etag": "string",
  "messageType": "string",
  "createdDateTime": "string (timestamp)",
  "lastModifiedDateTime": "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"}],
  "importance": "string",
  "policyViolation": "string",
  "reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
  "locale": "string",
  "deleted": true
}