chatMessage 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

表示 渠道聊天中的单个聊天信息。 该消息可以是根消息,也可以是消息中的 replyToId 属性定义的线程部分。

注意:此资源支持订阅更改, (使用 更改通知创建、更新和删除) 。 这使呼叫方可以实时订阅和获取更改。 有关详细信息,请参阅获取消息通知

方法

方法 返回类型 说明
频道消息
在通道中列出消息 chatMessage 集合 通道中所有根消息的列表。
创建新频道消息的订阅 订阅 侦听新消息、已编辑消息和已删除消息,以及对其的反应。
获取通道中的消息 chatMessage 获取通道中的单个根消息。
在通道中发送消息 chatMessage 在通道中创建新的根消息。
在频道中更新消息 None 更新聊天消息的属性。
删除通道中的消息 None 删除通道中的消息。
撤消频道中邮件的删除 None 取消删除通道中的消息。
在通道中设置对消息的反应 None 设置对通道中消息的反应。
取消设置对通道中消息的反应 None 取消设置对通道中消息的反应。
频道消息答复
列出邮件答复 chatMessage 集合 频道中对聊天消息的所有答复的列表。
在通道中获取答复消息 chatMessage 在频道中获取单个答复消息。
在频道中回复邮件 chatMessage 回复频道中的现有聊天消息。
更新回复消息 chatMessage 更新聊天消息的属性。
删除通道中的回复消息 chatMessage 删除通道中的单个答复消息。
撤消频道中答复邮件的删除 chatMessage 取消删除通道中的单个答复消息。
在通道中设置对答复消息的反应 chatMessage 在频道中设置对答复消息的反应。
取消设置对通道中答复消息的反应 chatMessage 取消设置对通道中答复消息的反应。
聊天消息
在聊天中列出消息 chatMessage 列出聊天中的聊天消息。
获取聊天中的消息 chatMessage 在聊天中获取单个聊天消息。
为用户在所有聊天中获取消息 聊天 集合 从用户参与的所有聊天中获取消息,包括 1:1 聊天、群组聊天和会议聊天。
获取用户的增量聊天消息 chatMessage 集合 从用户是参与者的所有聊天中获取消息列表,包括一对一聊天、群组聊天和会议聊天。
获取所有频道消息 channel 集合 获取用户参与的所有频道中的所有消息。
创建新聊天消息的订阅 订阅 侦听新的、编辑的和已删除的聊天消息,以及它们的反应。
在聊天中发送消息 chatMessage 在现有的 1:1 或群组聊天对话中发送聊天消息。
在聊天中更新消息 chatMessage 更新聊天消息的属性。
删除聊天中的消息 chatMessage 删除聊天消息。
撤消聊天中邮件的删除 chatMessage 在聊天中取消删除消息。
在聊天中设置对消息的反应 chatMessage 在聊天中设置对消息的反应。
取消设置对聊天中消息的反应 chatMessage 取消设置对聊天中消息的反应。
托管内容
列出所有托管内容 chatMessageHostedContent 集合 获取与消息关联的所有托管内容。
获取托管内容 chatMessageHostedContent 获取消息的托管内容 (及其字节) 。

属性

属性 类型 说明
附件 chatMessageAttachment 集合 对附加对象(如文件、选项卡、会议等)的引用。
body itemBody 聊天消息内容的纯文本/HTML 表示形式。 表示形式由正文中的 contentType 进行指定。 如果聊天消息包含 chatMessageMention,则内容始终采用 HTML 格式。
channelIdentity channelIdentity 如果消息是在通道中发送的,则表示通道的标识。
chatId string 如果消息是在 聊天中发送的,则表示 聊天的标识。
createdDateTime dateTimeOffset 创建聊天消息的时间戳。
deletedDateTime dateTimeOffset 只读。 删除聊天消息的时间戳;如果未删除,则为 null。
etag string 只读。 聊天消息的版本号。
eventDetail eventMessageDetail 此为只读属性。 如果存在,则表示 聊天频道团队中发生的事件的详细信息,例如添加新成员。 对于事件消息, messageType 属性将设置为 systemEventMessage
起始数量 chatMessageFromIdentitySet 聊天消息发件人的详细信息。 只能在 迁移期间设置。
id String 只读。 消息的唯一 ID。 ID 在聊天/频道/回复消息中是唯一的,但在其他聊天/频道/reply-to-messages 中可能会重复。
importance string 聊天消息的重要性。 可能的值包括 normalhighurgent
lastEditedDateTime dateTimeOffset 只读。 对聊天消息进行编辑时的时间戳。 在 Teams UI 中触发“已编辑”标志。 如果未进行编辑,则值为 null
lastModifiedDateTime dateTimeOffset 只读。 创建聊天消息 (初始设置) 或修改时的时间戳,包括添加或删除反应时。
区域设置 string 客户端设置的聊天消息的区域设置。 始终设置为 en-us
提及 chatMessageMention 集合 聊天消息中提到的实体列表。 支持的实体包括:用户、机器人、团队、频道、聊天和标记。
messageHistory chatMessageHistoryItem 集合 消息项的活动历史记录列表,包括消息上的修改时间和操作,如 reactionAdded、reactionRemoved 或反应更改。
messageType chatMessageType 聊天消息的类型。 可能的值包括 messagechatEventtypingunknownFutureValuesystemEventMessage。 请注意,必须使用 Prefer: include-unknown-enum-members 请求标头获取此 可进化枚举 中的以下值: systemEventMessage
onBehalfOf chatMessageFromIdentitySet 机器人代表用户发送消息时消息的用户属性。
policyViolation chatMessagePolicyViolation 定义数据丢失防护 (DLP) 应用程序设置的策略冲突的属性。
反应 chatMessageReaction 集合 此聊天消息的反应 (例如,例如“) ”。
replyToId string 只读。 线程的父聊天消息或根聊天消息的 ID。 (仅适用于频道中的聊天消息,不适用于 chats.)
subject string 聊天消息的主题(纯文本)。
摘要 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"
}