Enviar notificações do feed de atividades para usuários no Microsoft Teams

O feed de atividades do Microsoft Teams permite que os usuários façam a triagem de itens que exigem atenção, notificando-os sobre alterações. Você pode usar as APIs de notificação do feed de atividades no Microsoft Graph para estender essa funcionalidade aos seus aplicativos. Isso permite que seus aplicativos forneçam experiências mais avançadas e envolvam melhor os usuários, ajudando a mantê-los atualizados com as alterações nas ferramentas e fluxos de trabalho que usam.

Casos de uso de notificações de feed de atividades

  • Notícias: ajuda os usuários a se manterem atualizados com as informações mais recentes, como novas tarefas ou novas postagens.
  • Colaboração: quando você compartilha um arquivo ou faz uma @menção a um usuário em um comentário, os usuários podem ver uma visualização de texto na faixa de notificação.
  • Lembretes: uma notificação para informá-lo sobre um evento ou uma tarefa. Por exemplo, você tem uma data de conclusão de treinamento hoje e o aplicativo envia uma notificação de lembrete para ajudá-lo a se lembrar da tarefa ou do evento.
  • Alertas: Notificações, que requerem atenção urgente ou imediata. Por exemplo, a data de vencimento de um treinamento já passou ou um administrador enviou uma solicitação para corrigir um bug com a prioridade mais alta.

Vantagens das notificações do feed de atividades

  • A notificação do feed de atividades é uma integração nativa do Teams que leva o usuário diretamente ao aplicativo Guia, trazendo envolvimento adicional do usuário da Atividade para seu aplicativo.
  • A notificação do feed de atividades vem com uma notificação do sistema operacional na área de trabalho do Teams e nos clientes móveis, para que a atenção do usuário seja capturada do pop-up e do som do sistema.
  • O conteúdo da notificação é altamente personalizável, permitindo que os usuários visualizem o resumo dos eventos notificados.
  • Você pode fazer um deep link do seu aplicativo a uma notificação para que, quando um usuário selecionar a notificação, aumente o envolvimento do usuário com o aplicativo.
  • Você pode enviar notificações do feed de atividades para vários destinatários. Por exemplo, enviar uma notificação pessoal ou enviar notificações em lote para um grupo de usuários.
  • A localização do manifesto do aplicativo (anteriormente chamado de manifesto do aplicativo do Teams) dá suporte ao texto com modelo nas notificações do feed de atividades.

Entender os conceitos básicos das notificações do feed de atividades

No Teams, as notificações do feed de atividades consistem em vários bits de informação exibidos juntos, conforme mostrado na imagem a seguir:

A captura de tela mostra os componentes de uma notificação do feed de atividades.

Os componentes incluem:

Contador Descrição
1 Avatar: mostra quem iniciou a atividade.
2 Tipo de atividade ou ícone do aplicativo: o tipo de atividade ou ícone do aplicativo descreve o tipo de atividade. Para notificações de aplicativos, o ícone de linha é substituído por um ícone de aplicativo.
3 Título: Ator + motivo: Ator: Nome do usuário ou aplicativo que iniciou a atividade. Motivo: descreve a atividade.
4 Carimbo de data/hora: mostra quando a atividade aconteceu.
5 Visualização de texto: mostra uma linha truncada desde o início da notificação.
6 Local: mostra onde a atividade aconteceu no Teams.

O exemplo a seguir mostra os componentes juntos e fornece os detalhes sobre uma notificação.

A captura de tela mostra o exemplo para notificação.

Tipos de cartões de notificação do feed de atividades

As variantes a seguir mostram os tipos de cartões de notificação do feed de atividades que você pode exibir. O logotipo do aplicativo substitui o avatar do usuário para notificações geradas pelo aplicativo:

A captura de tela mostra as notificações do feed de atividades em uma área de trabalho.

Contador Descrição
1 Personalizado do Teams
2 Windows
3 Mac

Requisitos para usar as APIs de notificação do feed de atividades

As APIs de feed de atividades funcionam com um aplicativo do Teams. A seguir estão os requisitos para enviar notificações do feed de atividades:

  • O manifesto do aplicativo deve ter a ID do aplicativo Microsoft Entra adicionada à webApplicationInfo seção. Para obter mais informações, consulte Esquema de manifesto do aplicativo.
  • As notificações de atividade podem ser enviadas com ou sem tipos de atividade adicionados no manifesto do aplicativo.
    • Por padrão, você pode usar as APIs de notificação de atividade sem adicionar a activities seção no manifesto do aplicativo. O systemDefault tipo de atividade é reservado, o Actor+Reason que permite que você forneça texto de forma livre na linha da notificação do feed de atividades. Para obter mais informações, consulte Enviar notificações personalizáveis do feed de atividades.

      Observação

      O systemDefault tipo de atividade está disponível apenas na visualização pública do desenvolvedor.

    • Se você quiser enviar um modelo de notificação no modo tradicional, a activityTypes propriedade deverá ser adicionada na seção de atividades . Para obter mais informações, consulte Esquema de manifesto do aplicativo.
  • O aplicativo Teams deve ser instalado para o destinatário pessoalmente ou em uma equipe ou chat do qual ele faz parte.

Permissões

Use permissões delegadas ou de aplicativo para enviar notificações do feed de atividades. Ao usar permissões de aplicativo, recomendamos usar o RSC (consentimento específico do recurso), pois a TeamsActivity.Send.User permissão é consentida pelo usuário para enviar notificações de atividade. Certifique-se de adicionar as permissões RSC no arquivo de manifesto do aplicativo.

Atualização do manifesto do aplicativo

Esta seção descreve as atualizações que precisam ser adicionadas ao manifesto do aplicativo. Certifique-se de usar a versão 1.7 do manifesto do aplicativo ou posterior.

"$schema": "https://developer.microsoft.com/json-schemas/teams/v1.7/MicrosoftTeams.schema.json",
"manifestVersion": "1.7",

Atualização do webApplicationInfo

"webApplicationInfo":
{
    "id": "a3111f15-658e-457c-9689-fd20fe907330",
    "resource": "https://contosoapp.com"
}
Parâmetro Tipo Descrição
id string ID do aplicativo Microsoft Entra (ID do cliente).
resource string Recurso associado ao aplicativo Microsoft Entra. Também conhecido como URL de resposta ou redirecionamento no Portal do Microsoft Azure.

Observação

Você poderá receber um erro se vários aplicativos do Teams no mesmo escopo (equipe, chat ou usuário) estiverem usando o mesmo aplicativo Microsoft Entra. Verifique se você está usando aplicativos exclusivos do Microsoft Entra.

Atualização de atividades

"activities":
{
  "activityTypes": [
    {
      "type": "taskCreated",
      "description": "Task Created Activity",
      "templateText": "{actor} created task {taskId} for you"
    },
    {
      "type": "approvalRequired",
      "description": "Deployment requires your approval",
      "templateText": "{actor} created a new deployment {deploymentId}"
    }
  ]
}
Parâmetro Tipo Descrição
type string Tipo de atividade. Isso precisa ser exclusivo em um manifesto de aplicativo específico.
description string Breve descrição legível. Isso fica visível no cliente do Teams.
templateText string Modelo de texto para a notificação de atividade. Você pode adicionar seus parâmetros encapsulando os parâmetros em {}.

Observação

  • O actor é um parâmetro especial que sempre leva o nome do chamador. Em chamadas delegadas, actor é o nome do usuário. Em chamadas somente de aplicativo, ele usa o nome do aplicativo Teams.
  • O tipo de atividade reservada systemDefault não deve ser incluído na activities seção do manifesto do aplicativo. O systemDefault tipo de atividade permite que você forneça texto de forma livre na Actor+Reason linha da notificação do feed de atividades.

Atualização de autorização

"authorization": 
{ 
  "permissions": { 
    "resourceSpecific": [ 
      {
        "type": "Application", 
         "name": "TeamsActivity.Send.User" 
      }, 
      { 
        "type": "Application",
        "name": "TeamsActivity.Send.Group"
      }, 
      { 
        "type": "Application", 
        "name": "TeamsActivity.Send.Chat" 
      } 
    ] 
  }
}
Parâmetro Tipo Descrição
type string O tipo da permissão RSC.
nome string O nome da permissão RSC. Para obter mais informações, consulte Permissões RSC com suporte.

Instalar o aplicativo Teams

Os aplicativos do Teams devem ser instalados em uma equipe, chat ou para um usuário no escopo pessoal para que os usuários recebam notificações do feed de atividades. Para obter detalhes, consulte Métodos de distribuição de aplicativos do Teams. Para fins de desenvolvimento, preferimos o upload de aplicativos personalizados. Após o desenvolvimento, você poderá escolher o método de distribuição correto com base no fato de desejar publicar em um locatário ou em todos os locatários.

Você também pode usar APIs de instalação de aplicativos do Teams para gerenciar instalações de aplicativos do Teams.

Enviar notificações do feed de atividades aos usuários

Como um aplicativo do Teams pode ser instalado para um usuário, em uma equipe ou em um chat, ele também pode enviar notificações nos três contextos a seguir:

Além disso, você pode enviar notificações em massa para até 100 usuários por vez:

Para encontrar detalhes sobre os tópicos com suporte para cada cenário, consulte as APIs específicas. Há suporte para tópicos baseados em texto personalizado em todos os cenários.

Você pode usar a notificação do feed de atividades nos seguintes cenários:

  • Notifique as pessoas sobre conteúdo personalizado que exija sua atenção.
  • Mostrar conteúdo rico no aplicativo de guia ou URL.
  • Suporte a interações complexas do usuário.
  • Enviar notificações delegadas do usuário que iniciou a notificação.
  • Coloque o modelo no manifesto do aplicativo.
  • O Teams lida com a localização para notificações.

Observação

O ícone de atividade é baseado no contexto em que a solicitação é feita. Se a solicitação for feita com permissões delegadas, a foto do usuário aparecerá como o avatar, enquanto o ícone do aplicativo Teams aparecerá como o ícone de atividade. Em um contexto somente de aplicativo, o ícone do aplicativo Teams é usado como avatar e o ícone de atividade é omitido.

Personalizar as notificações

Os usuários do Teams podem personalizar as notificações que veem no feed ou como uma faixa. As notificações geradas por meio de APIs de feed de atividades também podem ser personalizadas. Os usuários podem escolher como são notificados por meio das configurações no Teams. Os aplicativos do Teams aparecem na lista para o usuário escolher, conforme mostrado na captura de tela a seguir:

A captura de tela mostra as configurações de Notificações no Teams, com a opção Personalizada realçada.

Os usuários podem selecionar Editar ao lado de um aplicativo e personalizar as notificações. O manifesto do aplicativo exibe o description campo.

A captura de tela mostra notificações personalizadas para Faixa e feed para um aplicativo do Teams.

Exemplos

Para obter exemplos sobre como enviar uma notificação do feed de atividades, consulte Exemplos de notificação do feed de atividades.

Tipo de atividade reservado para enviar notificações do feed de atividades

  • O systemDefault tipo de atividade é reservado e não pode ser usado no manifesto do aplicativo ao adicionar atividades.
  • Recomendamos o uso de notificações com modelo, pois elas dependem dos modelos de atividade no manifesto do aplicativo para notificações recorrentes e grandes lotes.
  • O systemDefault tipo de atividade reservado estará disponível mesmo se os outros tipos de atividade estiverem listados no manifesto do aplicativo.

Veja a seguir os benefícios e limitações para o tipo de systemDefault atividade:

Benefícios Limitações
Você pode testar novos cenários e experimentar as APIs de notificação do feed de atividades sem adicionar tipos de atividade ao manifesto do aplicativo.

Com os aplicativos da Loja do Teams, o systemDefault tipo de atividade simplifica o processo e economiza tempo, pois elimina a necessidade de ajustes constantes nos tipos de atividade no manifesto do aplicativo. O systemDefault tipo de atividade está pronto para uso imediatamente.		 Você não pode utilizar os recursos de localização internos fornecidos pelo manifesto do aplicativo.

Não é possível confiar no envio de notificações personalizáveis com o systemDefault tipo de atividade. Os usuários podem desativar todas as notificações do seu aplicativo com uma alternância nas configurações de cliente do Teams, o que pode obstruir a comunicação entre seu aplicativo e seus usuários.

Exemplo de código

Nome do exemplo Descrição .NET Node.js
Enviar notificações de feed de atividades O aplicativo de exemplo demonstra como enviar notificações do feed de atividades usando a API do Graph. View View

Guias passo a passo

Siga o guia passo a passo para enviar notificações do feed de atividades no Teams.

Confira também

  • Last updated on