Tipo de recurso chatMessage
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Representa un mensaje de chat individual dentro de un canal o chat. El mensaje puede ser un mensaje raíz o parte de una conversación que está definida por la propiedad del mensaje replyToId.
Nota: Este recurso admite la suscripción a cambios (crear, actualizar y eliminar) mediante notificaciones de cambios. Esto permite a los autores de llamadas suscribirse y obtener cambios en tiempo real. Para obtener más información, vea obtener notificaciones de mensajes.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| Mensajes del canal | ||
| Enumerar mensajes en el canal | Colección chatMessage | Lista de todos los mensajes raíz de un canal. |
| Crear una suscripción para los mensajes de canal nuevos | subscripción | Escuche los mensajes nuevos, editados y eliminados, y las reacciones a ellos. |
| Obtener mensaje en el canal | chatMessage | Obtenga un único mensaje raíz en un canal. |
| Enviar mensaje en el canal | chatMessage | Cree un nuevo mensaje raíz en un canal. |
| Actualizar mensaje en el canal | Ninguno | Actualice las propiedades de un mensaje de chat. |
| Eliminar mensaje en el canal | Ninguno | Elimine el mensaje en un canal. |
| Deshacer la eliminación de un mensaje en el canal | Ninguno | Recuperar el mensaje en un canal. |
| Establecer la reacción en un mensaje en el canal | Ninguno | Establezca la reacción en un mensaje en un canal. |
| Reacción no establecida a un mensaje en el canal | Ninguno | Reacción no establecida a un mensaje en un canal. |
| Respuestas de mensajes de canal | ||
| Enumerar las respuestas al mensaje | Colección chatMessage | Lista de todas las respuestas a un mensaje de chat en el canal. |
| Obtener mensaje de respuesta en el canal | chatMessage | Obtenga un único mensaje de respuesta en un canal. |
| Respuesta a un mensaje en el canal | chatMessage | Responder a un mensaje de chat existente en un canal. |
| Actualizar mensaje de respuesta | chatMessage | Actualice las propiedades de un mensaje de chat. |
| Eliminar mensaje de respuesta en el canal | chatMessage | Elimine el mensaje de respuesta único en un canal. |
| Deshacer eliminación de un mensaje de respuesta en el canal | chatMessage | Recupere el mensaje de respuesta único en un canal. |
| Establecer la reacción a un mensaje de respuesta en el canal | chatMessage | Establezca la reacción en un mensaje de respuesta en un canal. |
| Reacción no establecida a un mensaje de respuesta en el canal | chatMessage | Reacción no establecida a un mensaje de respuesta en un canal. |
| Mensajes de chat | ||
| Enumerar mensajes en el chat | chatMessage | Enumere los mensajes de chat en un chat. |
| Obtener mensaje de chat | chatMessage | Obtenga un único mensaje de chat en un chat. |
| Obtener mensajes en todos los chats para un usuario | colección de chats | Obtenga mensajes de todos los chats en los que un usuario participa, incluidos los chats 1:1, los chats grupales y los chats de reuniones. |
| Obtención de mensajes de chat delta para el usuario | Colección chatMessage | Obtenga la lista de mensajes de todos los chats en los que un usuario es participante, incluidos chats uno a uno, chats grupales y chats de reuniones. |
| Obtener todos los mensajes del canal | Colección channel | Obtiene todos los mensajes de todos los canales en los que un usuario es participante. |
| Crear una suscripción para los nuevos mensajes de chat | subscripción | Escuche los mensajes de chat nuevos, editados y eliminados, y sus reacciones. |
| Enviar mensaje en el chat | chatMessage | Envíe un mensaje de chat en una conversación de chat 1:1 o de grupo existente. |
| Actualizar mensaje en el chat | chatMessage | Actualice las propiedades de un mensaje de chat. |
| Eliminar mensaje en el chat | chatMessage | Elimine el mensaje de un chat. |
| Deshacer la eliminación de un mensaje en el chat | chatMessage | Recuperar el mensaje en un chat. |
| Establecer la reacción en un mensaje en el chat | chatMessage | Establezca la reacción en un mensaje en un chat. |
| Reacción no establecida a un mensaje en el chat | chatMessage | Reacción no establecida a un mensaje en un chat. |
| Contenido hospedado | ||
| Enumerar todo el contenido hospedado | colección chatMessageHostedContent | Obtenga todo el contenido hospedado asociado a un mensaje. |
| Obtener contenido hospedado | chatMessageHostedContent | Obtenga contenido hospedado (y sus bytes) para un mensaje. |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| attachments | Colección chatMessageAttachment | Referencias a objetos adjuntos como archivos, pestañas, reuniones, etc. |
| body | itemBody | Representación de texto no cifrado o HTML del contenido del mensaje de chat. La representación la especifica contentType en el cuerpo. El contenido siempre está en HTML si el mensaje de chat contiene un chatMessageMention. |
| channelIdentity | channelIdentity | Si el mensaje se envió en un canal, representa la identidad del canal. |
| chatId | string | Si el mensaje se envió en un chat, representa la identidad del chat. |
| createdDateTime | dateTimeOffset | Marca de tiempo de cuándo se creó el mensaje de chat. |
| deletedDateTime | dateTimeOffset | Solo lectura. Marca de tiempo en la que se eliminó el mensaje de chat o null si no se eliminó. |
| etag | string | Solo lectura. Número de versión del mensaje de chat. |
| eventDetail | eventMessageDetail | Solo lectura. Si está presente, representa los detalles de un evento que se produjo en un chat, un canal o un equipo, por ejemplo, agregando nuevos miembros. Para los mensajes de evento, la propiedad messageType se establecerá en systemEventMessage. |
| from | chatMessageFromIdentitySet | Detalles del remitente del mensaje de chat. Solo se puede establecer durante la migración. |
| id | Cadena | Solo lectura. Id. único del mensaje. Los identificadores son únicos dentro de un chat, canal o respuesta al mensaje, pero pueden duplicarse en otros chats, canales o mensajes de respuesta. |
| importance | string | La importancia del mensaje de chat. Los valores posibles son: normal, high, urgent. |
| lastEditedDateTime | dateTimeOffset | Solo lectura. Marca de tiempo cuando se realizaron modificaciones en el mensaje de chat. Desencadena una marca "Editada" en la interfaz de usuario de Teams. Si no se realiza ninguna modificación, el valor es null. |
| lastModifiedDateTime | dateTimeOffset | Solo lectura. Marca de tiempo cuando se crea o modifica el mensaje de chat (configuración inicial), incluso cuando se agrega o se quita una reacción. |
| locale | string | Configuración regional del mensaje de chat establecido por el cliente. Siempre se establece en en-us. |
| mentions | Colección chatMessageMention | Lista de entidades mencionadas en el mensaje de chat. Las entidades admitidas son: usuario, bot, equipo, canal, chat y etiqueta. |
| messageHistory | colección chatMessageHistoryItem | Lista del historial de actividad de un elemento de mensaje, incluidos el tiempo de modificación y las acciones, como reactionAdded, reactionRemoved o reaction changes, en el mensaje. |
| messageType | chatMessageType | Tipo de mensaje de chat. Los valores posibles son: message, chatEvent, typing, unknownFutureValue, systemEventMessage. Tenga en cuenta que debe usar el encabezado de solicitud Prefer: include-unknown-enum-members para obtener el siguiente valor en esta enumeración activable: systemEventMessage. |
| onBehalfOf | chatMessageFromIdentitySet | Atribución del usuario del mensaje cuando el bot envía un mensaje en nombre de un usuario. |
| policyViolation | chatMessagePolicyViolation | Define las propiedades de una infracción de directiva establecida por una aplicación de prevención de pérdida de datos (DLP). |
| reactions | Colección chatMessageReaction | Reacciones para este mensaje de chat (por ejemplo, Me gusta). |
| replyToId | string | Solo lectura. Identificador del mensaje de chat primario o del mensaje de chat raíz del subproceso. (Solo se aplica a mensajes de chat en canales, no chats). |
| subject | string | Asunto del mensaje de chat, en texto no cifrado. |
| summary | string | Texto de resumen del mensaje de chat que se puede usar para notificaciones push y vistas de resumen o vistas de retroceso. Solo se aplica a los mensajes de chat de canal, no a los mensajes de chat en un chat. |
| webUrl | string | Solo lectura. Vínculo al mensaje en Microsoft Teams. |
Relaciones
| Relación | Tipo | Descripción |
|---|---|---|
| Respuestas | Colección chatMessage | Respuestas para un mensaje especificado. Admite $expand los mensajes de canal. |
| hostedContents | colección chatMessageHostedContent | Contenido de un mensaje hospedado por Microsoft Teams: por ejemplo, imágenes o fragmentos de código. |
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"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"
}