Тип ресурса chatMessage
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет отдельное сообщение чата в канале или чате. Сообщение может быть корневым или частью беседы, определяемой свойством replyToId в сообщении.
Примечание. Этот ресурс поддерживает подписку на изменения (создание, обновление и удаление) с помощью уведомлений об изменениях. Это позволяет вызывающим подписаться на изменения и получать их в режиме реального времени. Дополнительные сведения см. в разделе Получение уведомлений о сообщениях.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Сообщения в канале | ||
| Вывод списка сообщений в канале | Коллекция chatMessage | Список всех корневых сообщений в канале. |
| Создать подписку на новые сообщения канала | subscription | Прослушивайте новые, измененные и удаленные сообщения и реакции на них. |
| Получение сообщения в канале | chatMessage | Получение одного корневого сообщения в канале. |
| Отправка сообщения в канале | chatMessage | Создайте новое корневое сообщение в канале. |
| Обновление сообщения в канале | Нет | Обновите свойства сообщения чата. |
| Удаление сообщения в канале | Нет | Удалите сообщение в канале. |
| Отмена удаления сообщения в канале | Нет | Отмена удаления сообщения в канале. |
| Настройка реакции на сообщение в канале | Нет | Настройка реакции на сообщение в канале. |
| Отмена реакции на сообщение в канале | Нет | Отмена реакции на сообщение в канале. |
| Ответы на сообщения канала | ||
| Вывод списка ответов на сообщение | Коллекция chatMessage | Список всех ответов на сообщение чата в канале. |
| Получение ответного сообщения в канале | chatMessage | Получение одного ответного сообщения в канале. |
| Ответ на сообщение в канале | chatMessage | Ответ на существующее сообщение чата в канале. |
| Обновление ответного сообщения | chatMessage | Обновите свойства сообщения чата. |
| Удаление ответного сообщения в канале | chatMessage | Удалите одно ответное сообщение в канале. |
| Отмена удаления ответного сообщения в канале | chatMessage | Отмена удаления одного ответного сообщения в канале. |
| Настройка реакции на ответное сообщение в канале | chatMessage | Настройка реакции на ответное сообщение в канале. |
| Отмена реакции на ответное сообщение в канале | chatMessage | Отмена реакции на ответное сообщение в канале. |
| Сообщения чата | ||
| Вывод списка сообщений в чате | chatMessage | Вывод списка сообщений чата в чате. |
| Получение сообщения в чате | chatMessage | Получение одного сообщения чата в чате. |
| Получение сообщений во всех чатах для пользователя | коллекция chat | Получайте сообщения из всех чатов, участником которых является пользователь, включая чаты 1:1, групповые чаты и чаты собраний. |
| Получение сообщений разностного чата для пользователя | Коллекция chatMessage | Получите список сообщений из всех чатов , участником которых является пользователь, включая чаты с одним на один, групповые чаты и чаты собраний. |
| Получение всех сообщений в канале | Коллекция channel | Получайте все сообщения каналов, в которые входит пользователь. |
| Создать подписку на новые сообщения чата | subscription | Прослушивайте новые, измененные и удаленные сообщения чата и реакции на них. |
| Отправка сообщения в чате | chatMessage | Отправка сообщения чата в существующей беседе в формате 1:1 или в групповом чате. |
| Обновление сообщения в чате | chatMessage | Обновите свойства сообщения чата. |
| Удаление сообщения в чате | chatMessage | Удалите сообщение чата. |
| Отмена удаления сообщения в чате | chatMessage | Отмена удаления сообщения в чате. |
| Настройка реакции на сообщение в чате | chatMessage | Настройка реакции на сообщение в чате. |
| Отмена реакции на сообщение в чате | chatMessage | Отмена реакции на сообщение в чате. |
| Размещенное содержимое | ||
| Список всего размещенного содержимого | коллекция chatMessageHostedContent | Получение всего размещенного содержимого, связанного с сообщением. |
| Получить размещенное содержимое | chatMessageHostedContent | Получение размещенного содержимого (и его байтов) для сообщения. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| attachments | Коллекция chatMessageAttachment | Ссылки на вложенные объекты, такие как файлы, вкладки, собрания и т. д. |
| body | itemBody | Представление содержимого сообщения чата в формате plaintext или HTML. Представление определяется параметром contentType в тексте. Если сообщение чата содержит chatMessageMention, содержимое всегда находится в ФОРМАТЕ HTML. |
| channelIdentity | channelIdentity | Если сообщение было отправлено в канале, представляет удостоверение канала. |
| chatId | string | Если сообщение было отправлено в чате, представляет удостоверение чата. |
| createdDateTime | dateTimeOffset | Метка времени создания сообщения чата. |
| deletedDateTime | dateTimeOffset | Только для чтения. Метка времени, с которой было удалено сообщение чата, или значение NULL, если оно не удалено. |
| etag | string | Только для чтения. Номер версии сообщения чата. |
| eventDetail | eventMessageDetail | Только для чтения. При наличии представляет сведения о событии, которое произошло в чате, канале или команде, например при добавлении новых участников. Для сообщений о событиях свойству messageType будет присвоено значение systemEventMessage. |
| from | chatMessageFromIdentitySet | Сведения об отправителе сообщения чата. Может быть задано только во время миграции. |
| id | String | Только для чтения. Уникальный идентификатор сообщения. Идентификаторы уникальны в чате, канале или ответе на сообщение, но могут дублироваться в других чатах, каналах и ответах на сообщения. |
| importance | string | Важность сообщения чата. Допустимые значения: normal, high, urgent. |
| lastEdEdDateTime | dateTimeOffset | Только для чтения. Метка времени внесения изменений в сообщение чата. Активирует флаг "Изменено" в пользовательском интерфейсе Teams. Если изменения не внесены, значение равно null. |
| lastModifiedDateTime | dateTimeOffset | Только для чтения. Метка времени создания сообщения чата (начального параметра) или изменения, в том числе при добавлении или удалении реакции. |
| языковые стандарты | string | Языковой стандарт сообщения чата, заданного клиентом. Всегда задавайте значение en-us. |
| mentions | Коллекция chatMessageMention | Список сущностей, упомянутых в сообщении чата. Поддерживаемые сущности: пользователь, бот, команда, канал, чат и тег. |
| messageHistory | коллекция chatMessageHistoryItem | Список журналов действий элемента сообщения, включая время изменения и действия, такие как реакцияДобавить, удалить реакцию или изменения реакции, в сообщении. |
| messageType | chatMessageType | Тип сообщения чата. Допустимые значения: message, chatEvent, typing, unknownFutureValue, systemEventMessage. Обратите внимание, что требуется использоваться заголовок запроса Prefer: include-unknown-enum-members, чтобы получить следующее значение в этом расширяемом перечислении: systemEventMessage. |
| onBehalfOf | chatMessageFromIdentitySet | Присвоение пользователем сообщения, когда бот отправляет сообщение от имени пользователя. |
| policyViolation | chatMessagePolicyViolation | Определяет свойства нарушения политики, заданного приложением защиты от потери данных (DLP). |
| reactions | Коллекция chatMessageReaction | Реакции на это сообщение чата (например, Нравится). |
| replyToId | string | Только для чтения. Идентификатор родительского сообщения чата или корневого сообщения чата потока. (Применяется только к сообщениям чата в каналах, а не к чатам.) |
| subject | string | Тема сообщения чата в виде открытого текста. |
| summary | string | Сводный текст сообщения чата, который можно использовать для push-уведомлений и сводных представлений или откатных представлений. Применяется только к сообщениям чата канала, а не к сообщениям чата в чате. |
| 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"
}