tipo de recurso chat
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.
Un chat 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 enumerados afectarán transitivamente a la reunión.
Métodos
| Método | Tipo de valor devuelto | Description |
|---|---|---|
| Administración de chats | ||
| Enumerar chats | colección de chats | Obtenga la lista de chats de los que forma parte un usuario. |
| Crear chat | chat | Cree un nuevo chat. |
| Obtener chat | chat | Lea las propiedades y las relaciones del chat. |
| Actualizar chat | chat | Actualice las propiedades del chat. |
| Eliminar chat | Ninguno | Eliminar un chat. |
| removeAllAccessForUser | Ninguno | Quitar el acceso a un chat para un usuario. |
| Listar a los miembros del chat | Colección conversationMember | Obtenga la lista de todos los usuarios del chat. |
| Agregar miembro del chat | Encabezado de ubicación | Agregue un usuario al chat. |
| Conseguir un miembro del chat | conversationMember | Obtenga un único usuario en el chat. |
| Quitar un miembro del chat | Ninguno | Quite un usuario del chat. |
| Obtener chat entre el usuario y la aplicación | chat | Obtenga un chat uno a uno entre el usuario y la aplicación. |
| Marcar el chat como leído | Ninguno | Marque chat como leído para un usuario. |
| Marcar el chat como no leído | Ninguno | Marcar el 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. |
| Mensajes | ||
| Enumerar mensajes en el chat | chatMessage | Obtener mensajes en un chat. |
| Obtener mensaje de chat | chatMessage | Obtener un único mensaje de un chat. |
| Obtener mensajes en todos los chats para un usuario | colección de chats | Obtener los mensajes de todos los chats en los que un usuario participa. |
| Obtener todos los mensajes de chat retenidos | Colección chatMessage | Obtenga todos los mensajes retenidos de todos los chats en los que un usuario es participante, incluidos los chats uno a uno, los chats grupales y los chats de reuniones. |
| Aplicaciones | ||
| Enumerar aplicaciones en el chat | Colección teamsappinstallation | Enumera las aplicaciones instaladas en un chat (y reunión asociada). |
| Obtener aplicación en el chat | teamsAppInstallation | Obtener una aplicación específica instalada en un chat (y reunión asociada). |
| Agregar aplicación en el chat | Agregue (instale) una aplicación en un chat (y una reunión asociada). | |
| Actualización de la aplicación 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). |
| Desinstalación de la aplicación del chat | Ninguno | Quite (desinstale) la aplicación de un chat (y la reunión asociada). |
| Enumerar concesiones de permisos | Colección de resourceSpecificPermissionGrant | Enumera los permisos que se han concedido a las aplicaciones de este chat. |
| Pestañas | ||
| Pestañas de lista en el chat | teamsTab | Mostrar 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 una reunión asociada). |
| Agregar pestaña al chat | teamsTab | Agregue (anclar) una pestaña a un chat (y una reunión asociada). |
| Pestaña Actualizar en el chat | teamsTab | Actualice las propiedades de una pestaña en un chat (y la reunión asociada). |
| Quitar pestaña del chat | Ninguno | Quite (desanclar) una pestaña de un chat (y una reunión asociada). |
| Operations | ||
| Enumerar operaciones en el chat | Colección teamsAsyncOperation | Obtenga la lista de operaciones asincrónicas que se ejecutaron o se ejecutan en el chat. |
| Obtener la operación en el chat | teamsAsyncOperation | Obtenga una única operación asincrónica que se ejecute o se ejecute en el chat. |
| Mensajes anclados | ||
| Lista de mensajes anclados | colección pinnedChatMessageInfo | Obtenga una lista de mensajes anclados en un chat. |
| Anclar un mensaje | pinnedChatMessageInfo | Anclar un mensaje de chat en un chat. |
| Desanclar un mensaje | Ninguno | Desanclar un mensaje de un chat. |
Nota: Al usar permisos de aplicación, asegúrese de que sabe cómo obtener el identificador de chat. Dado que no se admite la enumeración de chats con permisos de aplicación, no todos los escenarios son posibles. Es posible obtener identificadores de chat con permisos delegados y notificaciones de cambios para /chats/getAllMessages con permisos de aplicación.
Propiedades
| Propiedad | Tipo | Description |
|---|---|---|
| chatType | chatType | Especifica el tipo de chat. Los valores posibles son: group, oneOnOne, meeting y unknownFutureValue. |
| createdDateTime | dateTimeOffset | Fecha y hora en que se creó el chat. Solo lectura. |
| id | Cadena | Identificador único del chat. Solo lectura. |
| lastUpdatedDateTime | dateTimeOffset | Fecha y hora a la que se cambió el nombre del chat o se cambió por última vez la lista de miembros. Solo lectura. |
| 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. |
| tenantId | Cadena | Identificador del inquilino en el que se creó el chat. Solo lectura. |
| topic | String | (Opcional) Asunto o tema para el chat. Solo está disponible para los chats de grupo. |
| Mirador | chatViewpoint | Representa información específica del autor de la llamada sobre el chat, como la fecha y hora de lectura del último mensaje. Esta propiedad solo se rellena cuando la solicitud se realiza en un contexto delegado. |
| webUrl | String | 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 se fija para este tipo de chat; los miembros no se pueden quitar ni agregar. |
| grupo | Indica que el chat es un chat de grupo. 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 de sentinel de enumeración evolvable. No usar. |
Relaciones
| Relación | Tipo | Description |
|---|---|---|
| installedApps | Colección teamsappinstallation | 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 ha enviado ningún mensaje en el chat. Actualmente, solo la operación de chats de lista admite esta propiedad. |
| members | Colección conversationmember | 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 | Colección de todas las operaciones asincrónicas de Teams que se ejecutaron o se ejecutan 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 | Colección de todos los mensajes anclados en el chat. Admite un valor NULL. |
| pestañas | Colección teamsTab | Colección de todas las pestañas del chat. Admite valores NULL. |
Representación JSON
Esta es una representación JSON del recurso.
{
"chatType": "string",
"createdDateTime": "dateTimeOffset",
"id": "string (identifier)",
"lastUpdatedDateTime": "dateTimeOffset",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "string",
"topic": "string",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "string"
}