Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 20/06/2018

Referencia de la API REST de foto de usuario de Outlook

Se aplica a: Exchange Online | Office 365

Esta documentación trata sobre la versión beta de la API de foto de usuario en versión preliminar. Las características en versión preliminar pueden cambiar antes de su finalización, y pueden dañar código que las utilice. Por ello, en general, debería utilizar solo una versión de producción de una API en su código de producción. Si está disponible, v2.0 es actualmente la versión preferida.

La API de foto de usuario le permite descargar o configurar la foto de un usuario cuyo buzón está protegido por Azure Active Directory en Office 365.

Nota La API de foto de usuario no admite buzones de correo de consumidores en dominios de cuentas Microsoft, como Hotmail.com, Live.com, MSN.com, Outlook.com y Passport.com.

¿No está interesado en la versión beta de la API? Utilice el control en la esquina superior derecha y seleccione la versión que desee.

La API de foto de usuario le permite descargar o configurar la foto de un usuario cuyo buzón está protegido por Azure Active Directory en Office 365.

Nota La API de foto de usuario no admite buzones de correo de consumidores en dominios de cuentas Microsoft, como Hotmail.com, Live.com, MSN.com, Outlook.com y Passport.com.

¿No está interesado en la versión 2.0 de la API? Utilice el control en la esquina superior derecha y seleccione la versión que desee.

Uso de la API REST de foto de usuario

Autenticación

Como cualquier otra API REST de Outlook, para cada solicitud a la API de foto de usuario de Outlook, debería incluir un token de acceso válido. Obtener un token de acceso requiere que haya registrado e identificado su aplicación y obtenido la autorización correspondiente. Puede obtener más información sobre algunas opciones de registro y autorización optimizadas para usted. Tenga esto en cuenta a medida que avance con las operaciones específicas en la API de foto de usuario.

Versión de la API

El estado de esta API se ha promocionado de versión preliminar a disponibilidad general. Es compatible con las versiones 2.0 y beta de la API REST de Outlook.

Usuario objetivo

El usuario objetivo puede ser el usuario que ha iniciado sesión o un usuario especificado por un Id. de usuario.

Para obtener más información sobre el uso de esta API e información común a todos los subconjuntos de la API REST de Outlook, consulte Usar la API REST de Outlook.


Operaciones de foto de usuario

Las operaciones de foto del usuario le permiten obtener los metadatos de la foto del usuario y la transmisión de la foto en formato binario, y establecer la foto del usuario.

Además de entidadfoto, la API de foto de usuario proporciona una colecciónfotos que está en versión preliminar y disponible solo en la versión beta. La colección fotos le permite indicar tamaños específicos de la foto de usuario que le interesa.

Obtener metadatos de foto

Obtenga información sobre la foto de usuario solicitada, que incluye el tipo de contenido, eTag y el ancho y alto en píxeles.

Ámbito necesario Utilice uno de los ámbitos siguientes para obtener metadatos de foto del usuario especificado, que puede ser el usuario que ha iniciado sesión:

  • user.readbasic.all
  • user.read.all
  • user.readwrite.all

También puede usar el siguiente ámbito para obtener metadatos de foto específicamente del usuario que ha iniciado sesión:

  • user.read

Obtener los metadatos de la foto más grande disponible

GET https://outlook.office.com/api/beta/me/photo
GET https://outlook.office.com/api/beta/Users('{user_id}')/photo

Obtener los metadatos de todos los tamaños de foto disponibles

GET https://outlook.office.com/api/beta/me/photos
GET https://outlook.office.com/api/beta/Users('{user_id}')/photos

Obtener los metadatos de un tamaño de foto específico

GET https://outlook.office.com/api/beta/me/photos('{size}')
GET https://outlook.office.com/api/beta/Users('{user_id}')/photos('{size}')
Parámetro opcionalTipoDescripción
Parámetros de dirección URL
user_idcadenaLa dirección de correo electrónico del usuario.
sizecadenaUn tamaño de foto. El valor de '1x1' se genera automáticamente en el caso de que una foto no esté presente tanto en Active Directory como en el buzón.
Si la foto está almacenada en el buzón, los tamaños predefinidos son: '48x48', '64x64', '96x96', '120x120', '240x240', '360x360', '432x432', '504x504' y '648x648 '. Si el usuario no sube una foto lo suficientemente grande, solo están disponibles los tamaños que pueden representar los tamaños predefinidos más pequeños. Por ejemplo, si el usuario carga una foto de 504 x 504 píxeles, todos los tamaños de la foto salvo el de 648 x 648 estarán disponible para su descarga.
Las fotos pueden tener cualquier dimensión si se almacenan en Active Directory.

Ejemplo de solicitud Esta solicitud obtiene los metadatos de la imagen de 240x240 píxeles del usuario que ha iniciado la sesión.

GET https://outlook.office.com/api/beta/me/photos('240x240')

Ejemplo de datos de respuesta

Los siguientes datos de respuesta muestran los metadatos de la foto. El código de respuesta HTTP es 200.

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "@odata.mediaEtag": "\"BA09D118\"",
    "Id": "240X240",
    "Width": 240,
    "Height": 240
}

Los siguientes datos de respuesta muestran el contenido de una respuesta cuando no se ha subido ninguna foto para el usuario. El código de respuesta HTTP es 200.

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/gif",
    "@odata.mediaEtag": "",
    "Id": "1X1",
    "Width": 1,
    "Height": 1
}

Obtener los metadatos de la foto más grande disponible

GET https://outlook.office.com/api/v2.0/me/photo
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo
Parámetro opcionalTipoDescripción
Parámetros de dirección URL
user_idcadenaLa dirección de correo electrónico del usuario.

Ejemplo de solicitud Esta solicitud obtiene los metadatos de la foto del usuario que ha iniciado sesión.

GET https://outlook.office.com/api/v2.0/me/photo

Muestra de datos de respuesta

Los siguientes datos de respuesta muestran los metadatos de la foto. El código de respuesta HTTP es 200.

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "@odata.mediaEtag": "\"BA09D118\"",
    "Id": "240X240",
    "Width": 240,
    "Height": 240
}

Los siguientes datos de respuesta muestran el contenido de una respuesta cuando no se ha subido ninguna foto para el usuario. El código de respuesta HTTP es 200.

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/gif",
    "@odata.mediaEtag": "",
    "Id": "1X1",
    "Width": 1,
    "Height": 1
}

Obtener foto

Obtener la foto de usuario del usuario especificado.

Esta operación permite que un administrador de inquilinos permita que una aplicación obtenga la foto de usuario de cualquier usuario en el inquilino.

Ámbito necesario Utilice uno de los ámbitos siguientes para obtener la foto del usuario especificado, que puede ser el usuario que ha iniciado sesión:

  • user.readbasic.all
  • user.read.all
  • user.readwrite.all

También puede utilizar el ámbito siguiente para obtener la foto específicamente del usuario que ha iniciado sesión:

  • user.read
  • user.readwrite

**Obtener el tamaño más grande disponible **

GET https://outlook.office.com/api/beta/me/photo/$value
GET https://outlook.office.com/api/beta/Users('{user_id}')/photo/$value

Obtener la foto de un tamaño específico

GET https://outlook.office.com/api/beta/me/photos('{size}')/$value
GET https://outlook.office.com/api/beta/Users('{user_id}')/photos('{size}')/$value
Parámetro opcionalTipoDescripción
Parámetros de dirección URL
user_idcadenaLa dirección de correo electrónico del usuario.
sizecadenaUn tamaño de foto. El valor de '1x1' se genera automáticamente en el caso de que una foto no esté presente tanto en Active Directory como en el buzón.
Si la foto está almacenada en el buzón, los tamaños predefinidos son: '48x48', '64x64', '96x96', '120x120', '240x240', '360x360', '432x432', '504x504' y '648x648 '. Si el usuario no sube una foto lo suficientemente grande, solo están disponibles los tamaños que pueden representar los tamaños predefinidos más pequeños. Por ejemplo, si el usuario carga una foto de 504 x 504 píxeles, todos los tamaños de la foto salvo el de 648 x 648 estarán disponible para su descarga.
Las fotos pueden tener cualquier dimensión si se almacenan en Active Directory.

Ejemplo de solicitud

Esta solicitud recibe la foto del usuario que ha iniciado sesión.

GET https://outlook.office.com/api/beta/me/photo/$value
Content-Type: image/jpg

**Obtener el tamaño más grande disponible **

GET https://outlook.office.com/api/v2.0/me/photo/$value
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo/$value
Parámetro opcionalTipoDescripción
Parámetros de dirección URL
user_idcadenaLa dirección de correo electrónico del usuario.

Ejemplo de solicitud

Esta solicitud obtiene la foto del usuario que ha iniciado sesión.

GET https://outlook.office.com/api/v2.0/me/photo/$value
Content-Type: image/jpg

Datos de respuesta

Contiene los datos binarios de la foto solicitada. El código de respuesta HTTP es 200.


Establecer foto de usuario

Asignar una foto al usuario especificado. La foto debe estar en binario. Reemplaza cualquier foto existente para ese usuario.

Esta operación permite que un administrador de inquilinos permita que una aplicación establezca la foto de usuario de cualquier usuario en el inquilino. Utilice solo PUT para esta operación en la versión beta.

Ámbito necesario

Utilice el ámbito siguiente para configurar la foto del usuario especificado, que puede ser cualquier usuario del inquilino o del usuario que ha iniciado sesión:

  • user.readwrite.all

También puede utilizar el ámbito siguiente para obtener la foto específicamente del usuario que ha iniciado sesión:

  • user.readwrite
PUT https://outlook.office.com/api/beta/me/photo/$value
PUT https://outlook.office.com/api/beta/users('{user_id}')/photo/$value
Parámetro opcionalTipoDescripción
Parámetros de dirección URL
user_idcadenaLa dirección de correo electrónico del usuario.

Ejemplo de solicitud

PUT https://outlook.office.com/api/beta/me/photo/$value
Content-Type: image/jpeg

En el cuerpo de la solicitud, incluya los datos binarios de la foto.

Asignar una foto al usuario que ha iniciado sesión. La foto debe estar en binario. Reemplaza cualquier foto existente para ese usuario.

Puede utilizar PATCH o PUT para esta operación en la versión 2.0.

Ámbito necesario Utilice el ámbito siguiente para establecer la foto del usuario que ha iniciado sesión:

  • user.readwrite
PATCH https://outlook.office.com/api/v2.0/me/photo/$value
PATCH https://outlook.office.com/api/v2.0/users('{user_id}')/photo/$value

PUT https://outlook.office.com/api/v2.0/me/photo/$value
PUT https://outlook.office.com/api/v2.0/users('{user_id}')/photo/$value
Parámetro opcionalTipoDescripción
Parámetros de dirección URL
user_idcadenaLa dirección de correo electrónico del usuario.

Ejemplo de solicitud

PATCH https://outlook.office.com/api/v2.0/me/photo/$value
Content-Type: image/jpeg

En el cuerpo de la solicitud, incluya los datos binarios de la foto.

Datos de respuesta

Una solicitud con éxito devuelve HTTP 200.


Siguientes pasos

Tanto si está listo para empezar a compilar una aplicación como si simplemente desea obtener más información, tenemos todo lo que necesita.

O bien, obtenga más información sobre el uso de la plataforma de Office 365:

© 2018 Microsoft