Partilhar 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 preferencial e a atividade status para um utilizador. Se a presença preferencial de um utilizador estiver definida, a presença do utilizador é a presença preferencial.

A presença preferencial só entra em vigor quando existe, pelo menos, uma sessão de presença do utilizador. Caso contrário, a presença do utilizador permanece offline.

Uma sessão de presença pode ser criada como resultado de uma operação setPresence bem-sucedida ou se o utilizador tiver sessão iniciada num cliente do Teams.

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

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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/{id}/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 de base.
atividade string As informações suplementares sobre a disponibilidade.
expirationDuration duração A expiração da sessão de presença da aplicação. O valor é representado no formato ISO 8601 durante durações.
Se não for fornecido, será aplicada uma expiração predefinida:
DoNotDisturb ou Ocupado: expira dentro de 1 dia
Todas as outras: expira dentro de 7 dias

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

availability atividade Descrição
Disponível Disponível Defina a presença preferencial do utilizador como Disponível.
Ocupado Ocupado Defina a presença preferencial do utilizador como Ocupado.
DoNotDisturb DoNotDisturb Defina a presença preferencial do utilizador como DoNotDisturb.
BeRightBack BeRightBack Defina a presença preferencial do utilizador como BeRightBack.
Ausente Ausente Defina a presença preferencial do utilizador como Ausente.
Offline OffWork Defina a presença preferencial do utilizador como Offline.

Resposta

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

Exemplos

O pedido seguinte define a presença preferencial do utilizador como DoNotDisturb para o utilizador 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