命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示 渠道或聊天中的单个聊天信息。 该消息可以是根消息,也可以是消息中的 replyToId 属性定义的线程部分。
targetedChatMessage 资源是一种特殊类型的聊天消息,仅对指定的收件人可见。 有关详细信息,请参阅 targetedChatMessage。
注: 此资源支持订阅更改 (使用 更改通知创建、更新和删除) 。 这使呼叫方可以实时订阅和获取更改。 有关详细信息,请参阅获取消息通知。
方法
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| 附件 | chatMessageAttachment 集合 | 引用附加对象,如文件、选项卡、会议等。 |
| body | chatMessageBody | 聊天消息内容的纯文本/HTML/Markdown 表示形式。 表示形式由正文内的 messageBodyContentType (或已弃用的 contentType) 属性指定。 如果聊天消息包含 chatMessageMention,则内容始终是 HTML 格式。 |
| channelIdentity | channelIdentity | 如果消息是在通道中发送的,则表示通道的标识。 |
| chatId | string | 如果消息是在 聊天中发送的,则表示 聊天的标识。 |
| 引文 | chatMessageCitation 集合 | 只读。 引用邮件中引用的外部来源的内联引文。 引文是系统为机器人消息生成的,并显示为类型化集合。 |
| createdDateTime | dateTimeOffset | 创建聊天消息的时间戳。 |
| deletedDateTime | dateTimeOffset | 只读。 删除聊天消息的时间戳;如果未删除,则为 null。 |
| etag | string | 只读。 聊天消息的版本号。 |
| eventDetail | eventMessageDetail | 只读。 如果存在,表示 聊天、 频道或 团队中发生的事件的详细信息,例如添加新成员。 对于事件消息, messageType 属性将设置为 systemEventMessage。 |
| 起始数量 | chatMessageFromIdentitySet | 聊天消息发件人的详细信息。 只能在 迁移期间设置。 |
| id | String | 只读。 消息的唯一 ID。 ID 在聊天/频道/回复消息中是唯一的,但在其他聊天/频道/回复消息中可能重复。 |
| importance | chatMessageImportance | 邮件的重要性。 可能的值包括 normal、high、urgent、unknownFutureValue。 |
| lastEditedDateTime | dateTimeOffset | 只读。 对聊天消息进行编辑的时间戳。 在 Teams UI 中触发“已编辑”标志。 如果未进行任何编辑,则值为 null。 |
| lastModifiedDateTime | dateTimeOffset | 只读。 创建聊天消息 () 或修改初始设置(包括添加或删除回应时)的时间戳。 |
| 区域设置 | string | 客户端设置的聊天消息的区域设置。 始终设置为 en-us。 |
| 提及 | chatMessageMention 集合 | 聊天消息中提及的实体列表。 支持的实体包括:用户、机器人、团队、频道、聊天和标记。 |
| messageHistory | chatMessageHistoryItem 集合 | 消息项的活动历史记录列表,包括修改时间和操作,例如消息上的 reactionAdded、reactionRemoved 或反应更改。 |
| messageType | chatMessageType | 聊天消息的类型。 可能的值包括 message、chatEvent、typing、unknownFutureValue、systemEventMessage。 使用 Prefer: include-unknown-enum-members 请求标头获取此 可进化枚举中的以下成员: systemEventMessage. |
| onBehalfOf | chatMessageFromIdentitySet | 机器人代表用户发送消息时消息的用户归属。 |
| policyViolation | chatMessagePolicyViolation | 定义由数据丢失防护 (DLP) 应用程序设置的策略冲突的属性。 |
| 反应 | chatMessageReaction 集合 | 此聊天消息的回应 (例如,) 。 |
| replyToId | string | 只读。 线程的家长聊天消息或根聊天消息的 ID。 (仅适用于频道中的聊天消息,不适用于聊天。) |
| 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.chatMessageBody"},
"channelIdentity": {"@odata.type": "microsoft.graph.channelIdentity"},
"chatId": "String",
"citations": [{"@odata.type": "microsoft.graph.chatMessageCitation"}],
"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"
}