Ressource type chatMessage
Espace de noms: microsoft.graph
Représente un message de conversation individuelle au sein d’une entité de canal ou une conversation. Le message peut être un message d’origine ou une partie d’un fil de discussion qui est défini(e) par la propriétéreplyToIddans le message.
Remarque : Cette ressource prend en charge l’abonnement aux modifications (créer, mettre à jour et supprimer) à l’aide de notifications de modification. Les appelants peuvent ainsi s’abonner et obtenir des modifications en temps réel. Pour plus d’informations, consultez Obtenir des notifications pour les messages.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Messages de canal | ||
| Répertorier les messages dans le canal | collectionchatMessage | Liste de tous les messages racine dans un canal. |
| Créer un abonnement pour les nouveaux messages de canal | abonnement | Écoutez les messages nouveaux, modifiés et supprimés, ainsi que les réactions à ceux-ci. |
| Obtenir le message dans le canal | chatMessage | Obtenez un seul message racine dans un canal. |
| Envoyer un message dans le canal | chatMessage | Créez un message racine dans un canal. |
| Mettre à jour le message dans le canal | Aucun | Mettez à jour la propriété policyViolation d’un message de conversation. |
| Supprimer le message dans le canal | Aucun | Supprimez le message dans un canal. |
| Annuler la suppression d’un message dans le canal | Aucun | Annuler la suppression du message dans un canal. |
| Définir la réaction à un message dans le canal | Aucun | Définir la réaction à un message dans un canal. |
| Réaction non définie à un message dans le canal | Aucun | Réaction non définie à un message dans un canal. |
| Réponses aux messages de canal | ||
| Lister les réponses aux messages | collectionchatMessage | Liste de toutes les réponses à un message de conversation dans le canal. |
| Obtenir un message de réponse dans le canal | chatMessage | Obtenez un seul message de réponse dans un canal. |
| Répondre à un message dans le canal | chatMessage | Répondre à un message de conversation existant dans un canal. |
| Mettre à jour le message de réponse | chatMessage | Mettez à jour la propriété policyViolation d’un message de conversation. |
| Supprimer le message de réponse dans le canal | chatMessage | Supprimez le message de réponse unique dans un canal. |
| Annuler la suppression d’un message de réponse dans le canal | chatMessage | Annuler la suppression du message de réponse unique dans un canal. |
| Définir la réaction à un message dans le canal | Aucun | Définir la réaction à un message dans un canal. |
| Réaction non définie à un message dans le canal | Aucun | Réaction non définie à un message dans un canal. |
| Messages de conversation | ||
| Répertorier les messages dans la conversation | chatMessage | Répertorier les messages de conversation dans une conversation. |
| Obtenir le message dans une conversation | chatMessage | Obtenez un message de conversation unique dans une conversation. |
| Recevoir des messages dans toutes les conversations pour l’utilisateur | collection de conversations | Obtenez des messages de toutes les conversations auxquelles un utilisateur participe, notamment les conversations 1:1, les conversations de groupe et les conversations de réunion. |
| Obtenir des messages de conversation delta pour l’utilisateur | collectionchatMessage | Obtenez la liste des messages de toutes les conversations auxquelles un utilisateur participe, y compris les conversations en tête-à-tête, les conversations de groupe et les conversations de réunion. |
| Ajout de l’API de recherche de tous les messages de canal | collection channel | Obtenir tous les messages de tous les canaux auxquels un utilisateur participe. |
| Créer un abonnement pour les nouveaux messages de conversation | abonnement | Écoutez les messages de conversation nouveaux, modifiés et supprimés, ainsi que les réactions à ceux-ci. |
| Envoyer un message dans une conversation | chatMessage | Envoyer un message de conversation dans une conversation 1:1 ou de groupe existante. |
| Mettre à jour le message dans la conversation | chatMessage | Mettez à jour la propriété policyViolation d’un message de conversation. |
| Supprimer le message dans la conversation | chatMessage | Supprimez le message d’une conversation. |
| Annuler la suppression d’un message dans la conversation | chatMessage | Annuler la suppression du message dans une conversation. |
| Définir la réaction à un message dans le canal | Aucun | Définir la réaction à un message dans un canal. |
| Réaction non définie à un message dans le canal | Aucun | Réaction non définie à un message dans un canal. |
| Contenu hébergé | ||
| Répertorier tout le contenu hébergé | collection chatMessageHostedContent | Obtenir tout le contenu hébergé associé à un message. |
| Obtenir du contenu hébergé | chatMessageHostedContent | Obtenir le contenu hébergé (et ses octets) pour un message. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| pièces jointes | collectionchatMessageAttachment | Références à des objets joints tels que des fichiers, des onglets, des réunions, etc. |
| body | itemBody | Représentation en texte clair/HTML du contenu du message de conversation. La représentation est spécifiée par contentType dans le corps. Le contenu est toujours au format HTML si le message de conversation contient un chatMessageMention. |
| chatId | chaîne | Si le message a été envoyé dans une conversation, représente l’identité de la conversation. |
| channelIdentity | channelIdentity | Si le message a été envoyé dans un canal, représente l’identité du canal. |
| createdDateTime | dateTimeOffset | Horodatage de la création du message de conversation. |
| deletedDateTime | dateTimeOffset | En lecture seule. Horodatage auquel le message de conversation a été supprimé, ou null s’il n’est pas supprimé. |
| etag | chaîne | En lecture seule. Numéro de version du message de conversation. |
| eventDetail | eventMessageDetail | En lecture seule. Le cas échéant, représente les détails d’un événement qui s’est produit dans une conversation, un canal ou une équipe, par exemple, l’ajout de nouveaux membres. Pour les messages d’événement, la propriété messageType est définie sur systemEventMessage. |
| de | chatMessageFromIdentitySet | Détails de l’expéditeur du message de conversation. Peut être défini uniquement pendant la migration. |
| id | String | En lecture seule. ID unique du message. Les ID sont uniques au sein d’une conversation/d’un canal/d’une réponse à un message, mais peuvent être dupliqués dans d’autres conversations/canaux/réponses aux messages. |
| importance | string | Importance du message de conversation. Les valeurs possibles sont normal, high, urgent. |
| lastModifiedDateTime | dateTimeOffset | En lecture seule. Horodatage lorsque le message de conversation est créé (paramètre initial) ou modifié, y compris lorsqu’une réaction est ajoutée ou supprimée. |
| lastEditedDateTime | dateTimeOffset | En lecture seule. Horodatage lorsque des modifications ont été apportées au message de conversation. Déclenche un indicateur « Modifié » dans l’interface utilisateur Teams. Si aucune modification n’est apportée, la valeur est null. |
| local | string | Paramètres régionaux du message de conversation défini par le client. Toujours défini sur en-us. |
| mentions | collectionchatMessageMention | Liste des entités mentionnées dans le message de conversation. Les entités prises en charge sont les suivantes : utilisateur, bot, équipe et canal. |
| messageHistory | collection chatMessageHistoryItem | Liste de l’historique d’activité d’un élément de message, y compris l’heure et les actions de modification, telles que reactionAdded, reactionRemoved ou les modifications de réaction, sur le message. |
| messageType | chatMessageType | Type de message de conversation. Les valeurs possibles sont : message, chatEvent, typing, unknownFutureValue, systemEventMessage. Notez que vous devez utiliser l’en-tête de requête Prefer: include-unknown-enum-members pour obtenir la valeur suivante dans cette evolvable enum : systemEventMessage. |
| policyViolation | chatMessagePolicyViolation | Définit les propriétés d’une violation de stratégie définie par une application de protection contre la perte de données (DLP). |
| réactions | collectionchatMessageReaction | Réactions pour ce message de conversation (par exemple, J’aime). |
| replyToId | chaîne | En lecture seule. ID du message de conversation parent ou du message de conversation racine du thread. (S’applique uniquement aux messages de conversation dans les canaux, et non aux conversations.) |
| subject | string | Objet du message de conversation, en texte clair. |
| résumé | string | Texte de synthèse du message de conversation qui peut être utilisé pour les notifications Push et les vues récapitulatives ou les vues de secours. S’applique uniquement aux messages de conversation de canal, et non aux messages de conversation dans une conversation. |
| webUrl | chaîne | En lecture seule. Lien vers le message dans Microsoft Teams. |
Relations
| Relation | Type | Description |
|---|---|---|
| hostedContents | collection chatMessageHostedContent | Contenu d’un message hébergé par Microsoft Teams , par exemple, des images ou des extraits de code. |
| Réponses | collectionchatMessage | Réponses à un message spécifié. Prend en charge $expand les messages de canal. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"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",
"policyViolation": {"@odata.type": "microsoft.graph.chatMessagePolicyViolation"},
"reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
"replyToId": "String (identifier)",
"subject": "String",
"summary": "String",
"webUrl": "String"
}