Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
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 chat que es una colección de chatMessages entre uno o varios participantes. Los participantes pueden ser usuarios o aplicaciones.
Nota: Si el chat está asociado a una instancia de onlineMeeting , algunos de los métodos indicados afectan de forma transitiva a la reunión.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| Administración de chat | ||
| Lista | Colección de chats | Obtener la lista de chats de los que forma parte un usuario. |
| Crear | chat | Crear un nuevo chat. |
| Get | chat | Lee las propiedades y relaciones del chat. |
| Actualizar | chat | Actualice las propiedades del chat. |
| Delete | Ninguno | Eliminar un chat. |
| Quitar todo el acceso del usuario | Ninguno | Quitar el acceso de un usuario a un chat. |
| Enumerar los miembros | Colección conversationmember | Obtenga la lista de todos los usuarios del chat. |
| Agregar miembro | Encabezado de ubicación | Agregue un usuario al chat. |
| Obtener miembro | conversationMember | Obtener un solo usuario en el chat. |
| Eliminar miembro | Ninguno | Quite a un usuario del chat. |
| Obtener chat entre el usuario y la aplicación | chat | Obtén chat uno a uno entre el usuario y la aplicación. |
| Marcar chat como leído | Ninguno | Marcar chat como leído para un usuario. |
| Marcar chat como no leído | Ninguno | Marcar chat como no leído para un usuario. |
| Ocultar chat | Ninguno | Ocultar un chat para un usuario. |
| Mostrar chat | Ninguno | Mostrar un chat para un usuario. |
| Iniciar la migración | chat | Inicie la migración de mensajes externos habilitando el modo de migración en un chat existente. |
| Completar migración | chat | Complete la migración de mensajes externos quitando el modo de migración de un chat. |
| Mensajes | ||
| Enumerar mensajes en un chat | chatMessage | Obtener mensajes en un chat. |
| Obtener la respuesta del mensaje | chatMessage | Obtener un único mensaje de un chat. |
| Obtener mensajes en todos los chats | Colección de chats | Obtener los mensajes de todos los chats en los que un usuario participa. |
| Obtener mensajes retenidos en todos los chats | Colección chatMessage | Obtenga todos los mensajes retenidos de todos los chats en los que participa un usuario, incluidos los chats uno a uno, los chats de grupo y los chats de reunión. |
| Obtener mensajes de chat diferenciales para el usuario | Colección chatMessage | Obtenga la lista de mensajes de todos los chats en los que participa un usuario, incluidos los chats uno a uno, los chats de grupo y los chats de reunión. |
| Aplicaciones | ||
| Enumerar aplicaciones en el chat | Colección teamsappinstallation | Enumerar las aplicaciones instaladas en un chat (y la reunión asociada). |
| Instalar una aplicación en el chat | teamsAppInstallation | Instalar una aplicación específica en un chat (y la reunión asociada). |
| Agregar aplicación en el chat | Agregar (instalar) una aplicación en un chat (y reunión asociada). | |
| Actualizar aplicaciones instaladas en el chat | Ninguno | Actualice a la versión más reciente de la aplicación instalada en el chat (y la reunión asociada). |
| Quitar aplicación del chat | Ninguno | Quitar (desinstalar) una aplicación de un chat (y una reunión asociada). |
| Enumerar concesiones de permisos | Colección de resourceSpecificPermissionGrant | Enumere los permisos concedidos a las aplicaciones en este chat. |
| Pestañas | ||
| Enumerar pestañas en el chat | teamsTab | Enumerar pestañas ancladas a un chat (y reunión asociada). |
| Obtener pestaña en el chat | teamsTab | Obtener una pestaña específica anclada a un chat (y a una reunión asociada). |
| Agregar pestañas al chat | teamsTab | Agregar (anclar) una pestaña a un chat (y reunión asociada). |
| Actualizar pestaña en el chat | teamsTab | Actualizar las propiedades de una pestaña en un chat (y la reunión asociada). |
| Quitar pestaña del chat | Ninguno | Quitar (desanclar) una pestaña de un chat (y una reunión asociada). |
| Operations | ||
| Operaciones de lista | Colección teamsAsyncOperation | Obtenga la lista de las operaciones asincrónicas que se ejecutaron o se están ejecutando en el chat. |
| Obtener operación en el chat | teamsAsyncOperation | Obtenga una sola operación asincrónica que se ejecutó o se está ejecutando en el chat. |
| Mensajes anclados | ||
| Enumerar mensajes anclados | Colección pinnedChatMessageInfo | Obtener una lista de los mensajes anclados en un chat. |
| Anclar mensaje | pinnedChatMessageInfo | Anclar un mensaje de chat en un chat. |
| Desanclar mensaje | Ninguno | Desanclar un mensaje de un chat. |
Nota: Al usar permisos de aplicación, asegúrese de que sabe cómo obtener el id. de chat. Dado que no se admite la lista de chats con permisos de aplicación, no todos los escenarios son posibles. Es posible obtener identificadores de chat con permisos delegados y de notificaciones de cambio para /chats/getAllMessages con permisos de aplicación.
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| chatType | chatType | Especifica el tipo de chat. Los valores posibles son: group, oneOnOne, meeting y unknownFutureValue |
| createdBy | identitySet | El usuario o aplicación que creó el chat. Solo lectura. |
| createdDateTime | dateTimeOffset | Fecha y hora en que se creó el chat. Solo lectura. |
| id | Cadena | El identificador único del chat. Solo lectura. |
| isHiddenForAllMembers | Booleano | Indica si el chat está oculto para todos sus miembros. Solo lectura. |
| lastUpdatedDateTime | dateTimeOffset | Fecha y hora en que se cambió el nombre del chat o se cambió por última vez la lista de miembros. Solo lectura. |
| modo de migración | modo de migración | Indica si un chat está en modo de migración. Este valor es null para los chats que nunca entraron en el modo de migración. Los valores posibles son: inProgress, completed, unknownFutureValue. |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | Representa detalles sobre una reunión en línea. Si el chat no está asociado a una reunión en línea, la propiedad está vacía. Solo lectura. |
| originalCreatedDateTime | dateTimeOffset | Marca de tiempo de la hora de creación original del chat. El valor es null si el chat nunca entró en el modo de migración. |
| tenantId | Cadena | El identificador del espacio empresarial en el que se creó el chat. Solo lectura. |
| topic | Cadena | (Opcional) Asunto o tema del chat. Solo disponible para chats grupales. |
| punto de vista | chatViewpoint | Representa información específica del autor de la llamada sobre el chat, como la fecha y hora de la última lectura del mensaje. Esta propiedad solo se rellena cuando la solicitud se realiza en un contexto delegado. |
| webUrl | Cadena | La dirección URL del chat en Microsoft Teams. La dirección URL debe tratarse como un blob opaco y no analizarse. Solo lectura. |
valores chatType
| Member | Descripción |
|---|---|
| oneOnOne | Indica que el chat es un chat 1:1. El tamaño de la lista es fijo para este tipo de chat; Los miembros no se pueden quitar ni agregar. |
| grupo | Indica que el chat es un chat grupal. El tamaño de la lista (de al menos dos personas) se puede actualizar para este tipo de chat. Los miembros se pueden quitar o agregar más adelante. |
| Reunión | Indica que el chat está asociado a una reunión en línea. Este tipo de chat solo se crea como parte de la creación de una reunión en línea. |
| unknownFutureValue | Valor centinela de enumeración evolutiva. No usar. |
valores de migrationMode
| Member | Descripción |
|---|---|
| en curso | El chat entró en modo migración. |
| completada | El chat está fuera del modo de migración. |
| unknownFutureValue | Valor centinela de enumeración evolutiva. No usar. |
Relaciones
| Relación | Tipo | Description |
|---|---|---|
| installedApps | Colección teamsappinstallation | Una colección de todas las aplicaciones del chat. Admite valores NULL. |
| lastMessagePreview | chatMessageInfo | Vista previa del último mensaje enviado en el chat.
Null Si no se envía ningún mensaje en el chat. Actualmente, solo la operación de lista de chats admite esta propiedad. |
| members | Colección conversationmember | Una colección de todos los miembros del chat. Admite valores NULL. |
| messages | Colección chatMessage | Colección de todos los mensajes del chat. Admite valores NULL. |
| operations | Colección teamsAsyncOperation | Una colección de todas las operaciones asincrónicas de Teams que se ejecutaron o se están ejecutando en el chat. Admite un valor NULL. |
| permissionGrants | Colección de resourceSpecificPermissionGrant | Colección de permisos concedidos a las aplicaciones para el chat. |
| pinnedMessages | Colección pinnedChatMessageInfo | Una colección de todos los mensajes anclados en el chat. Admite un valor NULL. |
| pestañas | Colección teamsTab | Una colección de todas las pestañas del chat. Admite valores NULL. |
| targetedMessages | Colección targetedChatMessage | Una colección de mensajes dirigidos en el chat que solo son visibles para usuarios específicos. Admite valores NULL. No puede expandir esta relación mediante $expand. Los mensajes dirigidos también se pueden recuperar a través de la API userTeamwork: getAllTargetedMessages . |
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"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"
}