Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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 messages de conversation entre un ou plusieurs participants. Les participants peuvent être des utilisateurs ou des applications.
Remarque : si la conversation est associée à une instance de réunion en ligne, certaines des méthodes répertoriées ont un impact transitif sur la réunion.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Gestion des chats | ||
| List | Collection de conversations | Obtenir la liste des conversations dont un utilisateur fait partie. |
| Create | conversation | Créez une conversation. |
| Obtenir | conversation | Lisez les propriétés et les relations de la conversation. |
| Mettre à jour | conversation | Mettez à jour les propriétés de la conversation. |
| Supprimer | Aucun | Supprimer une conversation. |
| Supprimer tout accès pour l’utilisateur | Aucun | Supprimez 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 | Supprimez un utilisateur de la conversation. |
| Obtenir un chat entre l'utilisateur et l'application | conversation | Obtenez une conversation individuelle 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 lue | Aucun | Marquer une conversation comme non lue pour un utilisateur. |
| Masquer la conversation | Aucun | Masquer une conversation pour un utilisateur. |
| Afficher la conversation | Aucun | Afficher une conversation pour un utilisateur. |
| Démarrer la migration | conversation | Démarrez la migration des messages externes en activant le mode de migration dans une conversation existante. |
| Complete-Migration | conversation | Terminez la migration des messages externes en supprimant le mode de migration d’une conversation. |
| 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. |
| Recevoir des messages dans toutes les conversations | Collection de conversations | Obtenir les messages de toutes les conversations auxquelles un utilisateur participe. |
| Obtenir des messages conservés dans 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 réunion associée). |
| Installer l’application dans la conversation | teamsAppInstallation | Installer une application spécifique dans une conversation (et une réunion associée). |
| Ajouter une application dans la conversation | Ajouter (installer) une application dans une conversation (et une réunion associée). | |
| Mettre à niveau l’application installée dans une conversation | Aucun | Effectuer la mise à jour vers la dernière version de l’application installée dans la conversation (et les réunions associées). |
| Supprimer une application de la 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 | Listez les autorisations accordées aux applications dans cette conversation. |
| Onglets | ||
| Onglets de liste dans la conversation | teamsTab | Onglets de liste épinglés à une conversation (et réunion associée). |
| Obtenir l’onglet dans la conversation | teamsTab | Obtenez 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 Mise à jour dans la conversation | teamsTab | Mettez à jour les propriétés d’un onglet d’une conversation (et des réunions associées). |
| Supprimer l’onglet de la conversation | Aucun | Supprimer (désépingler) un onglet d’une conversation (et des réunions associées). |
| Operations | ||
| Répertorier les opérations | Collection teamsAsyncOperation | Obtenez la liste des opérations asynchrones qui se sont exécutées ou sont en cours d’exécution sur le chat. |
| Obtenir une opération sur la conversation | teamsAsyncOperation | Obtenez une seule opération asynchrone qui s’est exécutée ou est en cours d’exécution sur le chat. |
| Messages épinglés | ||
| Répertorier les messages épinglés | collection pinnedChatMessageInfo | Obtenez une liste des messages épinglés dans une conversation. |
| Épingler le message | pinnedChatMessageInfo | Épingler un message de conversation dans une conversation. |
| Détacher le message | Aucun | Détacher un message d’une conversation. |
Remarque : Lorsque vous utilisez des autorisations d’application, assurez-vous 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 à partir de 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 : 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 | Identifiant unique de la conversation. En lecture seule. |
| isHiddenForAllMembers | Booléen | 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. |
| migrationMode | migrationMode | Indique si une conversation est en mode de migration. Cette valeur est null pour les conversations qui ne sont jamais entrées en mode de migration. Les valeurs possibles sont inProgress, completed, unknownFutureValue. |
| 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. |
| originalCreatedDateTime | dateTimeOffset | Horodatage de l’heure de création initiale de la conversation. La valeur est si la conversation n’est null jamais entrée en mode de migration. |
| tenantId | String | Identificateur du client dans lequel la conversation a été créée. En lecture seule. |
| topic | String | (Facultatif) Objet ou sujet de la conversation. Disponible uniquement pour les conversations de groupe. |
| Point de vue | chatViewpoint | Représente les informations spécifiques à l’appelant sur la conversation, telles que la date et l’heure de lecture du dernier message. Cette propriété n’est remplie que 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 sentinelle d’énumération évolutive. Ne pas utiliser. |
migrationMode valeurs
| Member | Description |
|---|---|
| inProgress | Chat est entré en mode de migration. |
| terminé | Le chat est sorti du mode de migration. |
| unknownFutureValue | Valeur sentinelle d’énumération évolutive. Ne pas utiliser. |
Relations
| Relation | Type | Description |
|---|---|---|
| installedApps | collection teamsAppInstallation | Une 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 conversations de liste prend en charge cette propriété. |
| membres | Collection conversationMember | Une collection de tous les membres de la conversation. Peut avoir la valeur Null. |
| messages | collectionchatMessage | Une collection de tous les messages de la conversation. Peut avoir la valeur Null. |
| operations | Collection teamsAsyncOperation | Regroupement 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 | Une collection de tous les messages épinglés dans la conversation. Pouvant accepter la valeur Null. |
| onglets | Collection teamsTab | Une collection de tous les onglets de la conversation. Pouvant accepter la valeur Null. |
| targetedMessages | collecte targetedChatMessage | Collection de messages ciblés dans la conversation qui sont visibles uniquement par des utilisateurs spécifiques. Pouvant accepter la valeur Null. Vous ne pouvez pas développer cette relation à l’aide $expandde . Les messages ciblés peuvent également être récupérés via l’API userTeamwork : getAllTargetedMessages . |
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)",
"migrationMode": "String",
"onlineMeetingInfo": {"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"},
"originalCreatedDateTime": "String (timestamp)",
"tenantId": "String",
"topic": "String",
"viewpoint": {"@odata.type": "microsoft.graph.chatViewpoint"},
"webUrl": "String"
}