Compartilhar via


presença: setUserPreferredPresence

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Defina a disponibilidade e a atividade preferidas status para um usuário. Se a presença preferencial de um usuário for definida, a presença do usuário será a presença preferencial.

A presença preferencial só entra em vigor quando há pelo menos uma sessão de presença do usuário. Caso contrário, a presença do usuário permanece como Offline.

Uma sessão de presença pode ser criada como resultado de uma operação de setPresence bem-sucedida ou se o usuário estiver conectado a um cliente do Teams.

Leia mais sobre sessões de presença e seu tempo limite e expiração.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Presence.ReadWrite Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Presence.ReadWrite.All Indisponível.

Solicitação HTTP

POST /users/{userId}/presence/setUserPreferredPresence

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro Tipo Descrição
availability string As informações de presença base.
atividade string As informações complementares à disponibilidade.
expirationDuration duração A expiração da sessão de presença do aplicativo. O valor é representado no formato ISO 8601 para durações.
Se não for fornecido, uma expiração padrão será aplicada:
DoNotDisturb ou Busy: expira em 1 dia
Todos os outros: expira em 7 dias

As combinações com suporte de disponibilidade e atividade são:

availability atividade Descrição
Disponível Disponível Defina a presença preferencial do usuário como Disponível.
Ocupado Ocupado Defina a presença preferencial do usuário como Ocupado.
DoNotDisturb DoNotDisturb Defina a presença preferencial do usuário como DoNotDisturb.
BeRightBack BeRightBack Defina a presença preferencial do usuário como BeRightBack.
Longe Longe Defina a presença preferencial do usuário como Away.
Offline OffWork Defina a presença preferencial do usuário como Offline.

Resposta

Se tiver êxito, este método retornará um código de resposta 200 OK.

Exemplos

A solicitação a seguir define a presença preferencial do usuário como DoNotDisturb para o usuário fa8bf3dc-eca7-46b7-bad1-db199b62afc3, com a expiração de 8 horas.

Solicitação

POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setUserPreferredPresence
Content-Type: application/json

{
  "availability": "DoNotDisturb",
  "activity": "DoNotDisturb",
  "expirationDuration": "PT8H"
}

Resposta

HTTP/1.1 200 OK