Partilhar via


presença: setUserPreferredPresence

Namespace: microsoft.graph

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á mostrada como a status preferencial.

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

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

Para obter mais detalhes, confira sessões de presença e 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.
Application 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
atividade Cadeia de caracteres As informações complementares à disponibilidade.
availability Cadeia de caracteres As informações de presença base.
expirationDuration Duração A expiração da sessão de presença do aplicativo representada no formato ISO 8601 para durações.
Se não for fornecido, uma expiração padrão será aplicada:
- DoNotDisturb ou Busy: Expiração em 1 dia
- Todos os outros: expiração em 7 dias

A tabela a seguir lista combinações compatíveis de disponibilidade e atividade.

availability atividade Descrição
Disponível Disponível Defina a presença preferencial do usuário como Available.
Ocupado Ocupado Defina a presença preferencial do usuário como Busy.
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

Solicitação

O exemplo a seguir mostra uma solicitação que define a presença preferencial como DoNotDisturb para um usuário, com uma expiração de 8 horas.

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

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK