Type de ressource de conversation
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente une conversation qui est une collection de chatMessages entre un ou plusieurs participants. Les participants peuvent être des utilisateurs ou des applications.
Remarque : Si la conversation est associée à un instance onlineMeeting, certaines des méthodes répertoriées ont un impact transitif sur la réunion.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Gestion des conversations | ||
| Répertorier les conversations | collection de conversations | Obtenez la liste des conversations dont fait partie un utilisateur. |
| Créer une conversation | conversation | Créez une conversation. |
| Obtenir une conversation | conversation | Lit les propriétés et les relations de la conversation. |
| Mettre à jour la conversation | conversation | Mettez à jour les propriétés de la conversation. |
| Supprimer | Aucun | Supprimer une conversation. |
| Supprimer tous les accès pour l’utilisateur | Aucun | Supprimer l’accès à une conversation pour un utilisateur. |
| Liste des membres | Collection conversationMember | Obtenez la liste de tous les utilisateurs de la conversation. |
| Ajouter un membre | En-tête Location | Ajoutez un utilisateur à la conversation. |
| Récupérer un membre | conversationMember | Obtenez un utilisateur unique de la conversation. |
| Supprimer un membre | Aucun | Supprimer un utilisateur de la conversation. |
| Obtenir un chat entre l'utilisateur et l'application | conversation | Bénéficiez d’une conversation en personne entre l’utilisateur et l’application. |
| Marquer la conversation comme lue | Aucun | Marquer la conversation comme lue pour un utilisateur. |
| Marquer la conversation comme non lus | Aucun | Marquer la conversation comme non lus pour un utilisateur. |
| Masquer la conversation | Aucun | Masquer une conversation pour un utilisateur. |
| Afficher la conversation | Aucun | Afficher une conversation pour un utilisateur. |
| Messages | ||
| Répertorier les messages dans une conversation | chatMessage | Obtenir des messages dans une conversation. |
| Obtenir la réponse du message | chatMessage | Obtenez un seul message dans une conversation. |
| Obtenir des messages sur toutes les conversations | collection de conversations | Obtenir les messages de toutes les conversations auxquelles un utilisateur participe. |
| Obtenir des messages conservés sur toutes les conversations | collectionchatMessage | Obtenez tous les messages conservés 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. |
| 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. |
| Applications | ||
| Répertorier des applications dans la conversation | Collection teamsAppInstallation | Répertorier les applications installées dans une conversation (et la réunion associée). |
| Obtenir l’application installée dans la conversation | teamsAppInstallation | Obtenir une application spécifique installée dans une conversation (et la réunion associée). |
| Ajouter une application dans la conversation | Ajouter (installer) une application dans une conversation (et la réunion associée). | |
| Mettre à niveau l’application installée dans une conversation | Aucun | Mettez à jour vers la dernière version de l’application installée dans la conversation (et la réunion associée). |
| Supprimer l’application d’une conversation | Aucun | Supprimer (désinstaller) l’application d’une conversation (et de la réunion associée). |
| Répertorier les octrois d’autorisations | Collection resourceSpecificPermissionGrant | Répertorier les autorisations accordées aux applications dans cette conversation. |
| Onglets | ||
| Lister les onglets dans la conversation | teamsTab | Répertorier les onglets épinglés à une conversation (et à la réunion associée). |
| Obtenir l’onglet dans la conversation | teamsTab | Obtenir un onglet spécifique épinglé à une conversation (et à la réunion associée). |
| Ajouter un onglet à la conversation | teamsTab | Ajouter (épingler) un onglet à une conversation (et à la réunion associée). |
| Onglet Mettre à jour dans la conversation | teamsTab | Mettez à jour les propriétés d’un onglet dans une conversation (et la réunion associée). |
| Supprimer l’onglet de la conversation | Aucun | Supprimer (désépingler) un onglet d’une conversation (et de la réunion associée). |
| Operations | ||
| Répertorier les opérations | Collection teamsAsyncOperation | Obtenez la liste des opérations asynchrones exécutées ou en cours d’exécution sur la conversation. |
| Obtenir l’opération sur la conversation | teamsAsyncOperation | Obtenez une seule opération asynchrone exécutée ou en cours d’exécution sur la conversation. |
| Messages épinglés | ||
| Répertorier les messages épinglés | collection pinnedChatMessageInfo | Obtenez la liste des messages épinglés dans une conversation. |
| Épingler un message | épingléChatMessageInfo | Épinglez un message de conversation dans une conversation. |
| Désépingler le message | Aucun | Désépingler un message d’une conversation. |
Note: Lorsque vous utilisez des autorisations d’application, vérifiez que vous savez comment obtenir l’ID de conversation. Étant donné que la liste des conversations avec des autorisations d’application n’est pas prise en charge, tous les scénarios ne sont pas possibles. Il est possible d’obtenir des ID de conversation avec des autorisations déléguées et des notifications de modification pour /chats/getAllMessages avec des autorisations d’application.
Propriétés
| Propriété | Type | Description |
|---|---|---|
| chatType | chatType | Spécifie le type de conversation. Les valeurs possibles sont les suivantes : group, oneOnOne, meeting, unknownFutureValue. |
| createdBy | identitySet | L’utilisateur ou l’application qui a créé la conversation. En lecture seule. |
| createdDateTime | dateTimeOffset | Date et heure de création de la conversation. En lecture seule. |
| id | String | Identificateur unique de la conversation. En lecture seule. |
| isHiddenForAllMembers | Boolean | Indique si la conversation est masquée pour tous ses membres. En lecture seule. |
| lastUpdatedDateTime | dateTimeOffset | Date et heure auxquelles la conversation a été renommée ou la liste des membres a été modifiée pour la dernière fois. En lecture seule. |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | Représente les détails d’une réunion en ligne. Si la conversation n’est pas associée à une réunion en ligne, la propriété est vide. En lecture seule. |
| tenantId | String | Identificateur du locataire dans lequel la conversation a été créée. En lecture seule. |
| topic | String | (Facultatif) Objet ou rubrique de la conversation. Disponible uniquement pour les conversations de groupe. |
| point de vue | chatViewpoint | Représente des informations spécifiques à l’appelant sur la conversation, telles que la date et l’heure du dernier message lu. Cette propriété est renseignée uniquement lorsque la demande est effectuée dans un contexte délégué. |
| webUrl | String | URL de la conversation dans Microsoft Teams. L’URL doit être traitée comme un objet blob opaque et non analysée. En lecture seule. |
Valeurs chatType
| Member | Description |
|---|---|
| oneOnOne | Indique que la conversation est une conversation 1:1. La taille de la liste est fixe pour ce type de conversation ; les membres ne peuvent pas être supprimés/ajoutés. |
| group | Indique que la conversation est une conversation de groupe. La taille de la liste (d’au moins deux personnes) peut être mise à jour pour ce type de conversation. Les membres peuvent être supprimés/ajoutés ultérieurement. |
| réunion | Indique que la conversation est associée à une réunion en ligne. Ce type de conversation est créé uniquement dans le cadre de la création d’une réunion en ligne. |
| unknownFutureValue | Valeur sentinel de l’énumération évolutive. Ne pas utiliser. |
Relations
| Relation | Type | Description |
|---|---|---|
| installedApps | collection teamsAppInstallation | Collection de toutes les applications de la conversation. Pouvant accepter la valeur Null. |
| lastMessagePreview | chatMessageInfo | Aperçu du dernier message envoyé dans la conversation.
Null si aucun message n’est envoyé dans la conversation. Actuellement, seule l’opération de liste des conversations prend en charge cette propriété. |
| membres | Collection conversationMember | Collection de tous les membres de la conversation. Peut avoir la valeur Null. |
| messages | collectionchatMessage | Collection de tous les messages de la conversation. Peut avoir la valeur Null. |
| operations | Collection teamsAsyncOperation | Collection de toutes les opérations asynchrones Teams exécutées ou en cours d’exécution sur la conversation. Pouvant accepter la valeur Null. |
| permissionGrants | Collection resourceSpecificPermissionGrant | Collection d’autorisations accordées aux applications pour la conversation. |
| pinnedMessages | collection pinnedChatMessageInfo | Collection de tous les messages épinglés dans la conversation. Pouvant accepter la valeur Null. |
| onglets | Collection teamsTab | Collection de tous les onglets de la conversation. Pouvant accepter la valeur Null. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"chatType": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "string (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "String (timestamp)",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "String",
"topic": "String",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "String"
}