Usar o Microsoft Graph API para trabalhar com o Microsoft Teams
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.
O Microsoft Teams é um espaço de trabalho baseado em chat no Microsoft 365 que fornece acesso interno a calendários, arquivos, anotações do OneNote, planos do Planner e muito mais. Pode utilizar o Microsoft API do Graph para integrar com as funcionalidades do Microsoft Teams.
Casos de uso comuns
A tabela seguinte lista os casos de utilização comuns das APIs do Microsoft Teams no Microsoft Graph.
| Casos de uso | Recursos REST | Confira também |
|---|---|---|
| Criar e gerir equipas, grupos e canais | equipa, canal, grupo | criar equipa, listar equipas, criar um canal |
| Adicionar separadores, gerir ou instalar aplicações no catálogo de aplicações do Microsoft Teams | teamsTab, teamsAppInstallation | criar teamsTab, listar teamsTab, lista instalarAplicações |
| Criar canais e conversas para enviar e receber mensagens de chat | canal, chat, chatMessage | criar canal, canal de lista, enviar chatMessage num canal |
| Utilizar etiquetas para classificar utilizadores ou grupos com base em atributos comuns numa equipa | teamworkTag, teamworkTagMember | lista teamworkTag, criar teamworkTag |
| Criar e receber chamadas, chamar registos ou obter coordenadas de reunião | chamada, chamadaRegistos | resposta, convidar participantes |
| Ligar bots a chamadas e implementar uma resposta de voz interativa (IVR) | chamada | Cenários IVR |
| Criar e obter reuniões online ou marcar presença e atividade dos utilizadores | onlineMeeting, presença | criar onlineMeeting, meetingAttendanceReport |
| Criar e gerir a integração da força de trabalho com turnos, horários, cartões de horas ou folgas na sua organização | workforceIntegration, schedule, shift, timeOff, timeOffReason | criar workforceIntegration, criar agenda, criar turno, criar tempoOff |
| Utilizar a API de aprendizagem dos colaboradores para integrar com Viva Learning | aprendizagem de funcionários, learningProvider, learningContent | list learningProviders, list learningContents |
Cenários IVR
Seguem-se os cenários de Resposta de Voz Interativa (IVR) que as APIs de chamadas no Microsoft Graph suportam:
- Reproduzir um pedido de áudio , por exemplo, quando uma chamada é colocada na fila de um agente de suporte ao cliente.
- Grave uma resposta - por exemplo, para gravar o áudio do autor da chamada, normalmente depois de ouvir um pedido com opções.
- Subscreva os tons - por exemplo, quando quer saber que tons DTMF o autor da chamada selecionou, normalmente depois de ouvir o pedido de áudio.
- Cancelar o processamento de multimédia – por exemplo, quando pretender cancelar quaisquer operações playPrompt ou recordResponse que possam estar em processo.
Limites do Microsoft Teams
As limitações de desempenho e de capacidade testadas do Microsoft Teams estão documentadas nas especificações e limites do Microsoft Teams. Esses limites aplicam-se diretamente ao usar o Microsoft Teams ou usar as APIs do Microsoft Graph. Como todas as equipes têm um grupo correspondente, e cada grupo é um objeto de diretório, limites no número de grupos e o número de objetos de diretório ("recursos") também podem ser levados em consideração.
Os arquivos dentro de canais são armazenados no SharePoint. os limites do SharePoint Online se aplicam.
Confira também redução dos limites dos serviços do Microsoft Teams.
Equipes e grupos
Na Microsoft Graph, o Microsoft Teams é representado por um recurso de grupo. Os grupos do Microsoft Teams e Microsoft 365 atendem às várias necessidades de colaboração em grupo. Quase todos os recursos baseados em grupo se aplicam aos grupos do Microsoft Teams e do Microsoft 365, como calendário de grupo, arquivos, anotações, fotos, planos e assim por diante. A principal diferença entre uma equipe e um grupo do Microsoft 365 é o modo de comunicação entre os membros. Os membros do Teams se comunicam por meio de chat persistente no contexto de uma equipe específica. Os membros do grupo do Microsoft 365 se comunicam por conversas em grupo, que são conversas de email que ocorrem no contexto de um grupo no Outlook.
Qualquer grupo que tenha uma equipe possui uma propriedade resourceProvisioningOptions que contém "Team".
Observação: a propriedade Group.resourceProvisioningOptions pode ser alterada. Não adicione ou remova "Team" dessa coleção; caso contrário, você obterá resultados incorretos ao listar todas as equipes.
Veja a seguir as diferenças no nível da API entre equipes e grupos:
- O chat persistente está disponível apenas para o Microsoft Teams. Esse recurso é representado hierarquicamente pelos recursos channel e chatMessage.
- As conversas em grupo estão disponíveis apenas para grupos do Microsoft 365. Esse recurso é representado hierarquicamente pelos recursos conversation, conversationThread e post.
- O método Listar equipes unidas se aplica apenas ao Microsoft Teams.
- As APIs de chamadas e reuniões online aplicam-se apenas ao Microsoft Teams.
- Confira também os problemas conhecidos dessas APIs.
Alterações de associação no Microsoft Teams
| Caso de uso | Verbo | URL |
|---|---|---|
| Adicionar membro | POST | /teams/{team-id}/members |
| Remover membro | DELETE | /teams/{team-id}/members/{membership-id} |
| Atualizar a função do membro | PATCH | /teams/{team-id}/members/{membership-id} |
| Atualizar equipe | PATCH | /teams/{team-id} |
Requisitos de sondagem
Se seu aplicativo sonda para ver se um recurso foi alterado, você só poderá fazer isso uma vez por dia. (teamsAsyncOperation é uma exceção no sentido de que é foi desenvolvida para ser sondada frequentemente.) Se você precisar saber sobre mudanças com mais frequência que esta, você deve criar uma assinatura para esse recurso e receber notificações de alteração (webhooks). Caso não encontre suporte para o tipo de assinatura necessária, recomendamos que você faça comentários por meio do Fórum de ideias da Plataforma para Desenvolvedores do Microsoft 365 .
Ao pesquisar novas mensagens, você deve especificar um intervalo de datas onde isso for possível. Para obter mais informações, consulte Obter mensagens de chat delta para um utilizador.
As sondagem está executando uma operação OBTER em um recurso repetidamente para ver se o recurso foi alterado. Você tem permissão para obter o mesmo recurso várias vezes por dia, desde que não seja uma sondagem. Por exemplo, não há problema em OBTER /me/joinedTeams sempre que o utilizador visita/atualiza a sua página Web, mas não é possível obter /me/joinedTeams num ciclo a cada 30 segundos para atualizar essa página Web.
Os aplicativos que não seguem esses requisitos de sondagem serão considerados violações de termos de uso das APIs da Microsoft. A violação destes Termos da API pode resultar suspensãoou no cancelamento do uso das APIs da Microsoft.