Tipo de recurso de chat

Namespace: microsoft.graph

Um chat é uma coleção de chatMessages entre um ou mais participantes. Os participantes podem ser usuários ou aplicativos.

Observação: se o chat estiver associado a uma instância de onlineMeeting , alguns dos métodos listados afetarão transitivamente a reunião.

Métodos

Método Tipo de retorno Descrição
Gerenciamento de Chat
List Coleção de bate-papos Obtenha a lista de chats dos quais um usuário faz parte.
Create chat Crie um novo chat.
Get chat Leia as propriedades e as relações do chat.
Atualizar chat Atualizar as propriedades do chat.
Delete Nenhum Excluir um chat.
Listar membros coleção conversationMember Ver a lista de todos os usuários no bate-papo.
Adicionar membro Cabeçalho location Adicione um usuário ao chat.
Obter membro conversationMember Obter um único usuário no bate-papo.
Remover membro Nenhum Remover um usuário do chat.
Obter chat entre o usuário e o aplicativo chat Obtenha um bate-papo privado entre o usuário e o aplicativo
Remover todo o acesso do usuário Nenhum Remover o acesso a um chat para um usuário.
Iniciar migração chat Inicie a migração de mensagens externas habilitando o modo de migração em um chat existente.
Migração completa chat Conclua a migração de mensagens externas removendo o modo de migração de um chat.
Mensagens
Listar mensagens em um bate-papo chatMessage Receba mensagens em um chat.
Obter resposta da mensagem chatMessage Receba uma única mensagem em um bate-papo.
Receba mensagens em todos os chats Coleção de bate-papos Obter mensagens de todos os chats nos quais um usuário é um participante.
Obter mensagens retidas em todos os chats chatMessage collection Obtenha todas as mensagens retidas de todos os chats dos quais um usuário participa, incluindo chats individuais, chats em grupo e chats de reunião.
Obter mensagens de chat delta para o usuário chatMessage collection Obtenha a lista de mensagens de todos os chats dos quais um usuário é participante, incluindo chats individuais, chats em grupo e chats de reunião.
Aplicativos
Listar aplicativos no chat Coleção teamsAppInstallation Listar os aplicativos instalados em um chat (e reunião associada).
Obter aplicativo instalado no chat teamsAppInstallation Instalar um aplicativo específico em um chat (e na reunião associada).
Adicionar aplicativo ao chat Adicione (instale) um aplicativo em um chat (e reunião associada).
Atualizar aplicativo instalado no chat Nenhum Atualize para a versão mais recente do aplicativo instalado no chat (e reunião associada).
Remover o aplicativo do chat Nenhum Remova (desinstale) o aplicativo de um chat (e reunião associada).
Listar as concessões de permissões Coleção resourceSpecificPermissionGrant Liste as permissões concedidas aos aplicativos neste chat.
Guias
Listar guias no chat teamsTab Listar guias fixadas a um chat (e reunião associada).
Obter guia no chat teamsTab Obter uma guia específica fixada em um chat (e reunião associada).
Adicionar guia ao chat teamsTab Adicionar (fixar) uma guia a um chat (e reunião associada).
Atualizar guia no chat teamsTab Atualizar as propriedades de uma guia em um chat (e reunião associada).
Remover guia do chat Nenhum Remover (desafixar) uma guia de um chat (e reunião associada).
Mensagens fixadas
Listar mensagens fixadas Coleção pinnedChatMessageInfo Obter uma lista de mensagens fixadas em um chat.
Fixar mensagem pinnedChatMessageInfo Fixe uma mensagem de chat em um chat.
Desafixar mensagem Nenhum Desafixar uma mensagem de um chat.

Observação: Ao usar permissões de aplicativo, certifique-se de saber como obter a ID do chat. Como não há suporte para listar chats com permissões de aplicativo, nem todos os cenários são possíveis. É possível obter IDs de chat com permissões delegadas e de notificações de alteração para /chats/getAllMessages com permissões de aplicativo.

Propriedades

Propriedade Tipo Descrição
chatType chatType Especifica o tipo de chat. Os valores possíveis são: group, oneOnOne, meeting, unknownFutureValue.
createdDateTime dateTimeOffset Data e hora em que o chat foi criado. Somente leitura.
id Cadeia de caracteres O identificador exclusivo do chat. Somente leitura.
isHiddenForAllMembers Booliano Indica se o chat está oculto para todos os seus membros. Somente leitura.
lastUpdatedDateTime dateTimeOffset Data e hora em que o chat foi renomeado ou a lista de membros foi alterada pela última vez. Somente leitura.
migrationMode migrationMode Indica se um chat está no modo de migração. Esse valor é null para chats que nunca entraram no modo de migração. Os valores possíveis são: inProgress, completed, unknownFutureValue.
onlineMeetingInfo teamworkOnlineMeetingInfo Representa detalhes sobre uma reunião online. Se o chat não estiver associado a uma reunião online, a propriedade está vazia. Somente leitura.
originalCreatedDateTime dateTimeOffset Carimbo de data/hora da hora de criação original do chat. O valor é null se o chat nunca entrou no modo de migração.
tenantId String O identificador do locatário no qual o chat foi criado. Somente leitura.
topic Cadeia de caracteres (Opcional) Assunto ou tópico do chat. Disponível apenas para chats em grupo.
ponto de vista chatViewpoint Representa informações específicas do chamador sobre o chat, como a data e a hora de leitura da última mensagem. Essa propriedade é preenchida somente quando a solicitação é feita em um contexto delegado.
webUrl String A URL para o chat no Microsoft Teams. A URL deve ser tratada como um blob opaco e não analisada. Somente leitura.

valores chatType

Member Descrição
um contra um Indica que o chat é um chat 1:1. O tamanho da lista é fixo para esse tipo de chat; Os membros não podem ser removidos/adicionados.
group Indica que o chat é um chat em grupo. O tamanho da lista (de pelo menos duas pessoas) pode ser atualizado para esse tipo de chat. Os membros podem ser removidos/adicionados posteriormente.
reunião Indica que o chat está associado a uma reunião online. Esse tipo de chat só é criado como parte da criação de uma reunião online.
unknownFutureValue Valor sentinela de enumeração evolutiva. Não usar.

Relações

Relação Tipo Descrição
installedApps Coleção teamsAppInstallation Uma coleção de todos os aplicativos no chat. Anulável.
lastMessagePreview chatMessageInfo Visualização da última mensagem enviada no chat. Nulo se nenhuma mensagem foi enviada no chat. Atualmente, somente a operação de lista de chats dá suporte a essa propriedade.
members coleção conversationMember Um conjunto de todos os membros no chat. Anulável.
messages chatMessage collection Uma coleção de todas as mensagens no chat. Anulável.
permissionGrants Coleção resourceSpecificPermissionGrant Uma coleção de permissões concedidas a aplicativos para o chat.
Mensagens fixadas Coleção pinnedChatMessageInfo Uma coleção de todas as mensagens fixadas no chat. Anulável.
guias teamsTab collection Uma coleção de todas as guias do chat. Anulável.
targetedMessages targetedChatMessage collection Uma coleção de mensagens direcionadas no chat que são visíveis apenas para usuários específicos. Anulável. Você não pode expandir essa relação usando $expand. As mensagens direcionadas também podem ser recuperadas por meio da API userTeamwork: getAllTargetedMessages .

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "chatType": "String",
  "createdDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "isHiddenForAllMembers": "Boolean",
  "lastUpdatedDateTime": "String (timestamp)",
  "migrationMode": "String",
  "onlineMeetingInfo": {"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"},
  "originalCreatedDateTime": "String (timestamp)",
  "tenantId": "String",
  "topic": "String",
  "viewpoint": {"@odata.type": "microsoft.graph.chatViewpoint"},
  "webUrl": "String"
}

Conteúdo relacionado

  • Last updated on