Tipo de recurso chatMessage

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 de versão.

Representa uma mensagem de bate-papo individual em um canal ou bate-papo. A mensagem pode ser uma mensagem raiz ou parte de um thread definido pela propriedade replyToId na mensagem.

Observação: esse recurso dá suporte à assinatura de alterações (criar, atualizar e excluir) usando notificações de alteração. Isso permite aos chamadores assinar e obter alterações em tempo real. Para obter detalhes, confira obter notificações dede mensagens.

Métodos

Método	Tipo de retorno	Descrição
Mensagens do canal
Listar mensagens no canal	chatMessage collection	Lista de todas as mensagens raiz em um canal.
Obter delta de mensagens no canal	chatMessage	Obtenha mensagens incrementais em um canal.
Criar assinatura para novas mensagens de canal	assinatura	Ouça mensagens novas, editadas e excluídas e reações a elas.
Obter mensagem no canal	chatMessage	Obter uma única mensagem raiz em um canal.
Enviar mensagem no canal	chatMessage	Crie uma nova mensagem raiz em um canal.
Atualizar mensagem no canal	chatMessage	Atualize a propriedade policyViolation de uma mensagem de chat.
Excluir mensagem no canal	chatMessage	Exclua a mensagem em um canal.
Desfazer a exclusão de uma mensagem no canal	chatMessage	Restaurar a mensagem em um canal.
Respostas de mensagem de canal
Listar respostas à mensagem	chatMessage collection	Lista de todas as respostas a uma mensagem de chat no canal.
Obter mensagem de resposta no canal	chatMessage	Obtenha uma única mensagem de resposta em um canal.
Responder a uma mensagem no canal	chatMessage	Responder a uma mensagem de chat existente em um canal.
Atualizar mensagem de resposta	chatMessage	Atualize a propriedade policyViolation de uma mensagem de chat.
Excluir mensagem de resposta no canal	chatMessage	Exclua a única mensagem de resposta em um canal.
Desfazer exclusão de uma mensagem de resposta no canal	chatMessage	Restaurar a única mensagem de resposta em um canal.
Mensagens de chat
Listar mensagens no chat	chatMessage	Listar mensagens de chat em um chat.
Receba uma mensagem no bate-papo	chatMessage	Obtenha uma única mensagem de chat em um chat.
Obter mensagens em todos os chats para o usuário	coleção de chat	Obtenha mensagens de todos os chats em que um usuário é participante, incluindo chats 1:1, chats em grupo e chats de reunião.
Obter todas as mensagens do canal	channel collection	Obter todas as mensagens de todos os chats nos quais um usuário é um participante.
Criar assinatura para novas mensagens de chat	assinatura	Ouça mensagens de chat novas, editadas e excluídas e reações a elas.
Enviar mensagem no chat	chatMessage	Envie uma mensagem de chat em uma conversa de chat em grupo ou 1:1 existente.
Atualizar mensagem no chat	chatMessage	Atualize a propriedade policyViolation de uma mensagem de chat.
Excluir mensagem no chat	chatMessage	Exclua a mensagem de um chat.
Desfazer a exclusão de uma mensagem no chat	chatMessage	Restaurar a mensagem em um chat.
Conteúdo hospedado
Listar todo o conteúdo hospedado	Coleção chatMessageHostedContent	Obter todo o conteúdo hospedado associado a uma mensagem.
Obter conteúdo hospedado	chatMessageHostedContent	Obter conteúdo hospedado (e seus bytes) para uma mensagem.

Propriedades

Propriedade	Tipo	Descrição
attachments	chatMessageAttachment collection	Referências a objetos anexados, como arquivos, guias, reuniões etc.
corpo	itemBody	Representação de texto sem formatação/HTML do conteúdo da mensagem de chat. A representação é especificada pelo contentType dentro do corpo. O conteúdo estará sempre em HTML se a mensagem de chat contiver um chatMessageMention.
channelIdentity	channelIdentity	Se a mensagem foi enviada em um canal, representa a identidade do canal.
chatId	string	Se a mensagem foi enviada em um chat, representa a identidade do chat.
createdDateTime	dateTimeOffset	Carimbo de data/hora de quando a mensagem de chat foi criada.
deletedDateTime	dateTimeOffset	Somente leitura. Carimbo de data/hora em que a mensagem de chat foi excluída ou nulo se não for excluído.
etag	string	Somente leitura. Número de versão da mensagem de chat.
eventDetail	eventMessageDetail	Somente leitura. Se presente, representa detalhes de um evento que ocorreu em um chat, um canal ou uma equipe, por exemplo, adicionando novos membros. Para mensagens de evento, a propriedade messageType será definida como systemEventMessage.
from	chatMessageFromIdentitySet	Detalhes do remetente da mensagem de chat. Só pode ser definido durante a migração.
id	String	Somente leitura. ID única da mensagem.
importância	string	A importância da mensagem de chat. Os valores possíveis são: normal, high, urgent.
lastEditedDateTime	dateTimeOffset	Somente leitura. Carimbo de data/hora quando as edições da mensagem de chat foram feitas. Dispara um sinalizador "Editado" na interface do usuário do Teams. Se nenhuma edição for feita, o valor será null.
lastModifiedDateTime	dateTimeOffset	Somente leitura. Carimbo de data/hora quando a mensagem de chat é criada (configuração inicial) ou modificada, incluindo quando uma reação é adicionada ou removida.
localidade	string	Localidade da mensagem de chat definida pelo cliente. Sempre definido para en-us.
mentions	chatMessageMention collection	Lista de entidades mencionadas na mensagem de chat. As entidades com suporte são: usuário, bot, equipe, canal e marca.
messageType	chatMessageType	O tipo de mensagem de chat. Os valores possíveis são: message, chatEvent, typing, unknownFutureValue, systemEventMessage. Observe que você deve usar o cabeçalho de Prefer: include-unknown-enum-members solicitação para obter o seguinte valor nessa enumeração evolutiva: systemEventMessage.
onBehalfOf	chatMessageFromIdentitySet	Atribuição do usuário da mensagem quando o bot envia uma mensagem em nome de um usuário.
policyViolation	chatMessagePolicyViolation	Define as propriedades de um conjunto de violações de política por um aplicativo de prevenção contra perda de dados (DLP).
reactions	chatMessageReaction collection	Reações para essa mensagem de chat (por exemplo, Like).
replyToId	string	Somente leitura. ID da mensagem de chat pai ou da mensagem de chat raiz da conversa. (Aplica-se somente a mensagens de chat em canais, não chats.)
assunto	string	O assunto da mensagem de chat, em texto não criptografado.
summary	string	Texto de resumo da mensagem de chat que pode ser usado para notificações por push e exibições de resumo ou exibições de fallback. Aplica-se somente a mensagens de chat de canal, não mensagens de chat em um chat.
webUrl	cadeia de caracteres	Somente leitura. Link para a mensagem no Microsoft Teams.

Relações

Relação	Tipo	Descrição
Respostas	chatMessage	Respostas para uma mensagem especificada. Suporte para $expand mensagens de canal.
hostedContents	chatMessageHostedContent	Conteúdo em uma mensagem hospedada pelo Microsoft Teams , por exemplo, imagens ou snippets de código.

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "id": "string (identifier)",
  "replyToId": "string (identifier)",
  "from": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
  "etag": "string",
  "messageType": "string",
  "createdDateTime": "string (timestamp)",
  "lastModifiedDateTime": "string (timestamp)",
  "lastEditedDateTime": "string (timestamp)",
  "deletedDateTime": "string (timestamp)",
  "subject": "string",
  "body": {"@odata.type": "microsoft.graph.itemBody"},
  "summary": "string",
  "attachments": [{"@odata.type": "microsoft.graph.chatMessageAttachment"}],
  "mentions": [{"@odata.type": "microsoft.graph.chatMessageMention"}],
  "onBehalfOf": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
  "importance": "string",
  "reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
  "locale": "string",
  "policyViolation": {"@odata.type": "microsoft.graph.chatMessagePolicyViolation"},
  "chatId": "string",
  "channelIdentity": {"@odata.type": "microsoft.graph.channelIdentity"},
  "webUrl": "string",
  "eventDetail": {
    "@odata.type": "microsoft.graph.eventMessageDetail"
  }
}