Tipo de recurso chatMessage
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.
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 | subscription | Ouça mensagens novas, editadas e excluídas e reações a elas. |
Obter mensagem no canal | chatMessage | Obtenha 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 | Desdelete a mensagem em um canal. |
Definir a reação como uma mensagem no canal | Nenhum | Defina a reação como uma mensagem em um canal. |
Reação não configurada a uma mensagem no canal | Nenhum | Reação não configurada a uma 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 | Responda 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 | Desdelete a mensagem de resposta única em um canal. |
Definir a reação como uma mensagem no canal | Nenhum | Defina a reação como uma mensagem em um canal. |
Reação não configurada a uma mensagem no canal | Nenhum | Reação não configurada 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 | 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, que inclui 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 | subscription | 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 | Desdelete a mensagem em um chat. |
Definir a reação como uma mensagem no canal | Nenhum | Defina a reação como uma mensagem em um canal. |
Reação não configurada a uma mensagem no canal | Nenhum | Reação não configurada a uma mensagem em um canal. |
Conteúdo hospedado | ||
Listar todo o conteúdo hospedado | coleção chatMessageHostedContent | Obtenha todo o conteúdo hospedado associado a uma mensagem. |
Obter conteúdo hospedado | chatMessageHostedContent | Obtenha 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 plaintext/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 nula se não for excluída. |
etag | string | Somente leitura. Número da versão da mensagem de chat. |
eventDetail | eventMessageDetail | Somente leitura. Se estiver 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/reply-to-message, mas podem ser duplicadas em outros chats/canais/reply-to-messages. |
importância | cadeia de caracteres | A importância da mensagem de chat. Os valores possíveis são: normal , high , urgent . |
lastModifiedDateTime | dateTimeOffset | Somente leitura. Carimbo de data/hora quando a mensagem de chat é criada (configuração inicial) ou modificada, inclusive quando uma reação é adicionada ou removida. |
lastEditedDateTime | dateTimeOffset | Somente leitura. Carimbo de data/hora quando as edições para a 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 . |
localidade | cadeia de caracteres | 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 e canal. |
messageHistory | coleção chatMessageHistoryItem | Lista de histórico de atividades de um item de mensagem, incluindo tempo de modificação e ações, como reação Adicionada, reaçãoRemoved 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 . 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 . |
policyViolation | chatMessagePolicyViolation | Define as propriedades de uma violação de política definida por um aplicativo DLP (prevenção contra perda de dados). |
reactions | chatMessageReaction collection | Reações para esta mensagem de chat (por exemplo, Like). |
replyToId | cadeia de caracteres | Somente leitura. ID da mensagem de chat pai ou mensagem de chat raiz do thread. (Só se aplica a mensagens de chat em canais, não chats.) |
assunto | string | O assunto da mensagem de chat, em texto sem formatação. |
summary | string | Texto de resumo da mensagem de chat que pode ser usada para notificações por push e exibições de resumo ou modos de exibição de recuo. Aplica-se apenas 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 |
---|---|---|
hostedContents | coleção chatMessageHostedContent | Conteúdo em uma mensagem hospedada pelo Microsoft Teams – por exemplo, imagens ou snippets de código. |
Respostas | chatMessage collection | Respostas para uma mensagem especificada. $expand Dá suporte para mensagens de canal. |
Representação JSON
Veja a seguir uma representação JSON do 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"
}
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários