Compartilhar via

Referência de API REST da Foto do Usuário do Outlook (versão 2.0)

  • Artigo

Aplica-se ao: Exchange Online | Office 365

A API da Foto do Usuário permite baixar ou definir a foto de um usuário cuja caixa de correio esteja protegida pelo Active Directory do Azure no Office 365.

Observação

A API da Foto do Usuário não oferece suporte a caixas de correio de cliente em domínios de conta da Microsoft, como Hotmail.com, Live.com, MSN.com, Outlook.com e Passport.com.

Não tem interesse na v2.0 da API? Na tabela de conteúdo à esquerda, vá para a seção referência da API REST do Office 365 e selecione uma das versõesesejada.

Usando a API REST da Foto do Usuário

Autenticação

Como outra API REST do Outlook, você deve incluir um token de acesso válido a cada solicitação à API da Foto do Usuário do Outlook. A obtenção de um token de acesso exige que você registre e identifique seu aplicativo e obtenha a autorização adequada.

Saiba mais sobre algumas opções simplificadas de registro e autorização para você. Tenha isso em mente ao prosseguir com as operações específicas na API da Foto do Usuário.

Versão da API

Essa API foi promovida da versão prévia para o status de Disponibilidade Geral (GA). Há suporte nas versões v2.0 e beta da API REST do Outlook.

Usuário de destino

O usuário de destino pode ser o usuário conectado ou um usuário especificado por uma identificação do usuário.

Para obter mais informações sobre como usar essa API e informações comuns a todos os subconjuntos da API REST do Outlook, consulte Usar a API REST do Outlook.

Operações de foto do usuário

As operações de foto do usuário permitem que você obtenha os metadados e o fluxo da foto de um usuário em formato binário e defina a foto do usuário.

Obter metadados da foto

Obtenha informações sobre a foto do usuário solicitada, incluindo tipo de conteúdo, eTag e largura e altura em pixels.

Escopo requerido

Use um dos escopos a seguir para obter metadados da foto do usuário especificado, que pode ser o usuário conectado:

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

Também é possível usar o escopo a seguir para obter metadados da foto especificamente do usuário conectado:

  • user.read

Obter os metadados da maior foto disponível

GET https://outlook.office.com/api/v2.0/me/photo
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/photo
Parâmetro opcional Tipo Descrição
Parâmetros de Url
user_id sequência de caracteres O endereço de email do usuário.

Solicitação de amostra

Esta solicitação obtém os metadados da foto do usuário conectado.

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

Dados de resposta da amostra

Os dados de resposta a seguir mostram os metadados da foto. O código de resposta HTTP é 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
}

Os dados de resposta a seguir mostram o conteúdo de uma resposta quando uma foto ainda não foi carregada para o usuário. O código de resposta HTTP é 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
}

Obter foto

Obter a foto do usuário especificado.

Essa operação permite que um administrador de locatários deixe que um aplicativo obtenha a foto do usuário de qualquer usuário no locatário.

Escopo requerido

Use um dos escopos a seguir para obter metadados da foto do usuário especificado, que pode ser o usuário conectado:

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

Você também pode usar o escopo a seguir para obter a foto especificamente do usuário conectado:

  • user.read
  • user.readwrite

Obter o maior tamanho disponível

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 opcional Tipo Descrição
Parâmetros de Url
user_id sequência de caracteres O endereço de email do usuário.

Solicitação de amostra

Esta solicitação obtém a foto para o usuário conectado.

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

Dados de resposta

Contém os dados binários da foto solicitada. O código de resposta HTTP é 200.

Definir a foto do usuário

Atribuir uma foto ao usuário conectado. A foto deve estar em binário. Ela substitui qualquer foto existente para esse usuário.

Você pode usar PATCH ou PUT para esta operação na versão 2.0.

Escopo requerido

Escopo requerido Use o seguinte escopo para definir a foto do usuário conectado:

  • 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 opcional Tipo Descrição
Parâmetros de Url
user_id sequência de caracteres O endereço de email do usuário.

Solicitação de amostra

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

Inclui os dados binários da foto no corpo da solicitação.

Dados de resposta

Uma solicitação bem-sucedida retorna HTTP 200.

Próximas etapas

Se você estiver pronto para começar a criar um aplicativo ou apenas quiser aprender mais, temos tudo o que você precisa.

Se preferir, aprenda mais sobre como usar a plataforma do Office 365: