Exportar contenido con las API de exportación de Microsoft TeamsExport content with the Microsoft Teams Export APIs

Las API de exportación de equipos le permiten exportar 1:1 y mensajes de chat grupal de Microsoft Teams.Teams Export APIs allow you to export 1:1 and group chat messages from Microsoft Teams. Si su organización necesita exportar mensajes de Microsoft Teams, puede extraerlos con las API de exportación de Teams.If your organization needs to export Microsoft Teams messages, you are able to extract them using Teams Export APIs. El mensaje de chat representa un mensaje de chat individual dentro de un canal o un chat.Chat Message represents an individual chat message within a channel or chat. El mensaje de chat puede ser un mensaje de chat raíz o parte de un subproceso de respuesta definido por la propiedad replyToId en el mensaje de la conversación.The chat message can be a root chat message or part of a reply thread that is defined by the replyToId property in the chat message.

A continuación se muestran algunos ejemplos de uso de estas API de exportación:Here are some examples on how you can use these export APIs:

  • Ejemplo 1: Si ha habilitado Microsoft Teams en su organización y desea exportar todos los mensajes de Microsoft Teams a Date mediante programación, pase el intervalo de fechas para un usuario dado.Example 1: If you have enabled Microsoft Teams in your organization and want to export all the Microsoft Teams messages to date programmatically by passing the date range for a given user.
  • Ejemplo 2: Si desea exportar mediante programación todos los mensajes de usuario a diario proporcionando un intervalo de fechas.Example 2: If you want to programmatically export all user messages daily by providing a date range. Las API de exportación pueden recuperar todos los mensajes creados o actualizados durante el intervalo de fechas dado.Export APIs can retrieve all the messages created or updated during the given date range.

¿Qué es compatible con las API de exportación de Teams?What is supported by the Teams Export APIs?

  • Exportación en masa del mensaje de Teams: Las API de exportación de equipos admiten hasta 200 RPS por aplicación por espacio empresarial y 600 RPS para una aplicación, con estos límites debe poder exportar en bloque los mensajes de Teams.Bulk Export of Teams Message: Teams Export APIs support up to 200 RPS Per App Per tenant and 600 RPS for an Application, with these limits you should be able to bulk export of Teams messages.

  • Contexto de la aplicación: para llamar a Microsoft Graph, la aplicación debe adquirir un token de acceso de la plataforma de identidades de Microsoft.Application Context: To call Microsoft Graph, your app must acquire an access token from the Microsoft identity platform. El token de acceso contiene información sobre la aplicación y los permisos que tiene para los recursos y las API disponibles a través de Microsoft Graph.The access token contains information about your app and the permissions it has for the resources and APIs available through Microsoft Graph. Para obtener un token de acceso, la aplicación debe registrarse en la plataforma de identidad de Microsoft y su autorización es autorizada por un usuario o un administrador para acceder a los recursos de Microsoft Graph que necesita.To get an access token, your app must be registered with the Microsoft identity platform and be authorized by either a user or an administrator for access to the Microsoft Graph resources it needs.

    Si ya está familiarizado con la integración de una aplicación con la plataforma de identidades de Microsoft para obtener tokens, consulte la sección pasos siguientes para obtener información y ejemplos específicos de Microsoft Graph.If you are already familiar with integrating an app with the Microsoft identity platform to get tokens, see the Next Steps section for information and samples specific to Microsoft Graph.

  • Entorno híbrido: Las API de exportación son compatibles con los usuarios que se aprovisionan en un entorno híbrido (Exchange local y Teams).Hybrid Environment: Export APIs support messages sent by users who are provisioned on Hybrid Environment (on-premises Exchange and Teams). Los mensajes que envíen los usuarios que estén configurados para un entorno híbrido serán accesibles con las API de exportación.Any messages that are sent by users who are configured for hybrid environment will be accessible using Export APIs.

  • Mensajes eliminados por el usuario: Se puede acceder a los mensajes eliminados por el usuario del cliente de Teams mediante el uso de API de exportación hasta 30 días desde el momento de la eliminación.User Deleted Messages: Messages that are deleted by user from Teams client can be accessed using export APIs up to 30 days from the time of deletion.

  • Datos adjuntos de mensaje: Las API de exportación incluyen los vínculos a los datos adjuntos que se envían como parte de los mensajes.Message Attachments: Export APIs include the links to the attachments that are sent as part of messages. Con las API de exportación, puedes recuperar los archivos adjuntos en los mensajes.Using Export APIs you can retrieve the files attached in the messages.

  • Propiedades del mensaje de la conversación: Consulte la lista completa de propiedades que los equipos de exportación de API admiten aquí.Chat Message Properties: Refer to the complete list of properties that Teams Export APIs support here.

Cómo obtener acceso a las API de exportación de TeamsHow to access Teams Export APIs

  • El ejemplo 1 es una consulta sencilla para recuperar todos los mensajes de un usuario sin ningún filtro:Example 1 is a simple query to retrieve all the messages of a user without any filters:

    GET https://graph.microsoft.com/beta/users/{id}/chats/allMessages
    
  • El ejemplo 2 es una consulta de ejemplo para recuperar todos los mensajes de un usuario mediante la especificación de filtros de fecha y hora y los mensajes más importantes de 50:Example 2 is a sample query to retrieve all the messages of a user by specifying date time filters and top 50 messages:

    GET https://graph.microsoft.com/beta/users/{id}/chats/allMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z
    

Nota

La API devuelve la respuesta con el vínculo de página siguiente en caso de varios resultados.The API returns response with next page link in case of multiple results. Para obtener el siguiente conjunto de resultados, simplemente llama a GET en la dirección URL desde @odata. NEXTLINK.For getting next set of results, simply call GET on the url from @odata.nextlink. Si @odata. NEXTLINK no está presente o null, se recuperarán todos los mensajes.If @odata.nextlink is not present or null then all messages are retrieved.

Requisitos previos para acceder a las API de exportación de TeamsPrerequisites to access Teams Export APIs

  • Las API de exportación de Teams se encuentran en versión preliminar.Teams Export APIs are currently in preview. Solo estará disponible para los usuarios y los inquilinos que tengan las licencias necesarias para las API.It will only be available to users and tenants that have the required licenses for APIs. En el futuro, Microsoft puede requerir que usted o sus clientes paguen cargos adicionales en función de la cantidad de datos a los que se obtiene acceso a través de la API.In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data accessed through the API.

  • Las API de Microsoft Teams de Microsoft Graph que tienen acceso a datos confidenciales se consideran API protegidas.Microsoft Teams APIs in Microsoft Graph that access sensitive data are considered protected APIs. Las API de exportación requieren una validación adicional, además de los permisos y el consentimiento, antes de que puedas usarlas.Export APIs require that you have additional validation, beyond permissions and consent, before you can use them. Para solicitar acceso a estas API protegidas, completa el formulario de solicitud.To request access to these protected APIs, complete the request form.

  • Los permisos de aplicación se usan en las aplicaciones que se ejecutan sin un usuario que ha iniciado sesión; los permisos de la aplicación solo los puede enviar un administrador.Application permissions are used by apps that run without a signed-in user present; application permissions can only be consented by an administrator. Se necesitan los siguientes permisos:The following permissions are needed:

    • Chat. Read. All: permite el acceso a todos los mensajes de 1:1 y chat grupalChat.Read.All: enables access to all 1:1 and Group chat messages
    • User. Read. All: permite el acceso a la lista de usuarios de un inquilino.User.Read.All: enables access to the list of users for a tenant

Representación JSONJSON representation

El ejemplo siguiente es una representación JSON del recurso:The following example is a JSON representation of the resource:

Espacio de nombres: Microsoft. GraphNamespace: microsoft.graph

{
"id": "string (identifier)",
"replyToId": "string (identifier)",
"from": {"@odata.type": "microsoft.graph.identitySet"},
"etag": "string",
"messageType": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"deletedDateTime": "string (timestamp)",
"subject": "string",
"from": {
                "application": null,
                "device": null,
                "conversation": null,
                "user": {
                    "id": "string (identifier)",
                    "displayName": "string",
                    "userIdentityType": "aadUser"                }
            },
"body": {"@odata.type": "microsoft.graph.itemBody"},
"summary": "string",
"chatId": "string (identifier)"
"attachments": \[{"@odata.type": "microsoft.graph.chatMessageAttachment"}\],
"mentions": \[{"@odata.type": "microsoft.graph.chatMessageMention"}\],
"importance": "string",
"locale": "string",
}

Nota

Para obtener más información sobre el recurso chatMessage, vea el artículo sobre el tipo de recurso chatMessage .For more details on chatMessage resource, see the chatMessage resource type article.