Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Namespace: microsoft.graph
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.
O recurso targetedChatMessage é um tipo especializado de mensagem de chat visível apenas para destinatários especificados. Para obter mais informações, consulte targetedChatMessage.
Observação: este 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. |
| Criar assinatura para novas mensagens de canal | subscription | Ouça mensagens novas, editadas e excluídas e as reações a elas. |
| Obter mensagem no canal | chatMessage | Receba uma única mensagem raiz em um canal. |
| Enviar mensagem no canal | chatMessage | Crie uma nova mensagem raiz em um canal. |
| Atualizar mensagem no canal | Nenhum | Atualize a propriedade policyViolation de uma mensagem de chat. |
| Excluir mensagem no canal | Nenhum | Exclua a mensagem em um canal. |
| Desfazer a exclusão de uma mensagem no canal | Nenhum | Cancelar exclusão da mensagem em um canal. |
| Definir reação a uma mensagem no canal | Nenhum | Definir reação a uma mensagem em um canal. |
| Reação sem definição a uma mensagem no canal | Nenhum | Reação sem definição a uma mensagem em um canal. |
| Respostas de mensagens 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 | Receba 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 mensagem de resposta única em um canal. |
| Desfazer a exclusão de uma mensagem de resposta no canal | chatMessage | Cancelar exclusão da mensagem de resposta única em um canal. |
| Definir reação a uma mensagem no canal | Nenhum | Definir reação a uma mensagem em um canal. |
| Reação sem definição a uma mensagem no canal | Nenhum | Reação sem definição a uma mensagem 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 | Receba uma única mensagem de chat em um chat. |
| Obter mensagens em todos os chats para o usuário | Coleção de bate-papos | Receba mensagens de todos os chats dos quais um usuário participa, incluindo chats 1:1, 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. |
| 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 | subscription | Ouça mensagens de chat novas, editadas e excluídas e as reações a elas. |
| Enviar mensagem no chat | chatMessage | Envie uma mensagem de chat em uma conversa individual ou de chat em grupo. |
| 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 | Cancelar exclusão da mensagem em um chat. |
| Definir reação a uma mensagem no canal | Nenhum | Definir reação a uma mensagem em um canal. |
| Reação sem definição a uma mensagem no canal | Nenhum | Reação sem definição a uma mensagem em um canal. |
| Responder com citação | chatMessage | Responda com citação a uma única mensagem de chat ou a várias mensagens de chat em um chat. |
| Conteúdo hospedado | ||
| Listar todo o conteúdo hospedado | chatMessageHostedColeção de conteúdo | 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 em 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. |
| chatId | string | Se a mensagem foi enviada em um chat, representa a identidade do chat. |
| channelIdentity | channelIdentity | Se a mensagem foi enviada em um canal, representa a identidade do canal. |
| 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 da versão da mensagem de chat. |
| eventDetail | eventMessageDetail | Somente leitura. Se presente, representa detalhes de um evento que aconteceu 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. As IDs são exclusivas em um chat/canal/resposta à mensagem, mas podem ser duplicadas em outros chats/canais/mensagens de resposta. |
| importância | chatMessageImportance | A importância da mensagem. Os valores possíveis são: normal, high, urgent, unknownFutureValue. |
| lastEditedDateTime | dateTimeOffset | Somente leitura. Carimbo de data/hora em que as edições na 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 em que a mensagem de chat é criada (configuração inicial) ou modificada, incluindo quando uma reação é adicionada ou removida. |
| localidade | string | Local 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 suportadas são: usuário, bot, equipe, canal, chat e marca. |
| messageHistory | coleção chatMessageHistoryItem | Lista do histórico de atividades de um item de mensagem, incluindo tempo de modificação e ações, como reactionAdded, reactionRemoved ou alterações de reação, na mensagem. |
| messageType | chatMessageType | O tipo de mensagem de chat. Os valores possíveis são: message, chatEvent, typing, unknownFutureValue, systemEventMessage. Use o cabeçalho da Prefer: include-unknown-enum-members solicitação para obter os seguintes membros nesta enumeração evolutiva: systemEventMessage. |
| policyViolation | chatMessagePolicyViolation | Define as propriedades de uma violação de política definida por um aplicativo de prevenção contra perda de dados (DLP). |
| reactions | chatMessageReaction collection | Reações a esta mensagem de chat (por exemplo, Curtir). |
| replyToId | string | Somente leitura. ID da mensagem de chat pai ou mensagem de chat raiz do thread. (Aplica-se apenas a mensagens de chat em canais, não a chats.) |
| assunto | string | O assunto da mensagem de chat, em texto sem formatação. |
| summary | string | Texto resumido 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 apenas a mensagens de chat do canal, não a 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 |
|---|---|---|
| conteúdo hospedado | chatMessageHostedColeção de conteúdo | Conteúdo em uma mensagem hospedada pelo Microsoft Teams - por exemplo, imagens ou trechos de código. |
| respostas | chatMessage collection | Respostas para uma mensagem especificada. Suportes $expand para mensagens de canal. |
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
{
"attachments": [{"@odata.type": "microsoft.graph.chatMessageAttachment"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"channelIdentity": {"@odata.type": "microsoft.graph.channelIdentity"},
"chatId": "String",
"createdDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"etag": "String",
"eventDetail": {"@odata.type": "microsoft.graph.eventMessageDetail"},
"from": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
"id": "String (identifier)",
"importance": "String",
"lastEditedDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"locale": "String",
"mentions": [{"@odata.type": "microsoft.graph.chatMessageMention"}],
"messageHistory": [{"@odata.type": "microsoft.graph.chatMessageHistoryItem"}],
"messageType": "String",
"policyViolation": {"@odata.type": "microsoft.graph.chatMessagePolicyViolation"},
"reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
"replyToId": "String (identifier)",
"subject": "String",
"summary": "String",
"webUrl": "String"
}