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 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.
Nota: este recurso suporta a subscrição de alterações (criar, atualizar e eliminar) através de 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 num canal. |
| Criar assinatura para novas mensagens de canal | subscription | Escutar mensagens novas, editadas e eliminadas e reações às mesmas. |
| Obter mensagem no canal | chatMessage | Obter uma única mensagem de raiz num canal. |
| Enviar mensagem no canal | chatMessage | Criar uma nova mensagem de raiz num canal. |
| Atualizar mensagem no canal | Nenhum | Atualize as propriedades de uma mensagem de chat. |
| Eliminar mensagem no canal | Nenhum | Elimine a mensagem num canal. |
| Anular a eliminação de uma mensagem no canal | Nenhum | Anular a eliminação da mensagem num canal. |
| Definir a reação a uma mensagem no canal | Nenhum | Definir a reação a uma mensagem num canal. |
| Anular a reação a uma mensagem no canal | Nenhum | Anular a reação a uma mensagem num canal. |
| Respostas a 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 | Obter uma única mensagem de resposta num canal. |
| Responder a uma mensagem no canal | chatMessage | Responder a uma mensagem de chat existente num canal. |
| Atualizar mensagem de resposta | chatMessage | Atualize as propriedades de uma mensagem de chat. |
| Eliminar mensagem de resposta no canal | chatMessage | Elimine a mensagem de resposta única num canal. |
| Anular a eliminação de uma mensagem de resposta no canal | chatMessage | Anular a eliminação da mensagem de resposta única num canal. |
| Definir a reação a uma mensagem de resposta no canal | chatMessage | Definir a reação a uma mensagem de resposta num canal. |
| Anular a reação a uma mensagem de resposta no canal | chatMessage | Anular a reação a uma mensagem de resposta num canal. |
| Mensagens de chat | ||
| Listar mensagens no chat | chatMessage | Listar mensagens de chat numa conversa. |
| Receba uma mensagem no bate-papo | chatMessage | Obter uma única mensagem de chat numa conversa. |
| Obter mensagens em todos os chats para o usuário | coleção de chat | Obtenha mensagens de todas as conversas nas quais um utilizador participa, incluindo conversas de 1:1, conversas de grupo e conversas de reunião. |
| Obter mensagens de chat delta para o utilizador | chatMessage collection | Obtenha a lista de mensagens de todas as conversas nas quais um utilizador é participante, incluindo conversas um-para-um, conversas de grupo e conversas 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 | Escutar mensagens de chat novas, editadas e eliminadas e reações às mesmas. |
| Enviar mensagem no chat | chatMessage | Envie uma mensagem de chat numa conversação de chat de grupo ou 1:1 existente. |
| Atualizar mensagem no chat | chatMessage | Atualize as propriedades de uma mensagem de chat. |
| Eliminar mensagem no chat | chatMessage | Elimine a mensagem de uma conversa. |
| Anular a eliminação de uma mensagem no chat | chatMessage | Anular a eliminação da mensagem numa conversa. |
| Definir a reação a uma mensagem no chat | chatMessage | Definir a reação a uma mensagem numa conversa. |
| Anular a reação a uma mensagem no chat | chatMessage | Anular a reação a uma mensagem numa conversa. |
| Conteúdo alojado | ||
| Listar todo o conteúdo hospedado | chatMessageHostedContent collection (coleção chatMessageHostedContent ) | Obter todos os conteúdos alojados associados a uma mensagem. |
| Obter conteúdo hospedado | chatMessageHostedContent | Obtenha conteúdo alojado (e os respetivos bytes) para uma mensagem. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| attachments | chatMessageAttachment collection | Referências a objetos anexados, como ficheiros, separadores, reuniões, etc. |
| corpo | itemBody | Representação em texto simples/HTML do conteúdo da mensagem de chat. A representação é especificada pelo contentType dentro do corpo. O conteúdo está sempre em HTML se a mensagem de chat contiver um chatMessageMention. |
| channelIdentity | channelIdentity | Se a mensagem tiver sido enviada num canal, representa a identidade do canal. |
| chatId | string | Se a mensagem tiver sido enviada numa conversa, 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 no qual a mensagem de chat foi eliminada ou nulo se não for eliminada. |
| etag | string | Somente leitura. Número da versão da mensagem de chat. |
| eventDetail | eventMessageDetail | Somente leitura. Se estiver presente, representa os detalhes de um evento que ocorreu numa conversa, num canal ou numa equipa, por exemplo, a adicionar 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. Os IDs são exclusivos numa conversa/canal/resposta a mensagem, mas podem ser duplicados noutras conversas/canais/responder a mensagens. |
| 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 foram efetuadas edições à mensagem de chat. Aciona um sinalizador "Editado" na IU do Teams. Se não forem efetuadas edições, o valor será null. |
| lastModifiedDateTime | dateTimeOffset | Somente leitura. Carimbo de data/hora quando a mensagem de chat é criada (definição inicial) ou modificada, incluindo quando uma reação é adicionada ou removida. |
| localidade | cadeia de caracteres | Região 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: utilizador, bot, equipa, canal, chat e etiqueta. |
| messageHistory | chatMessageHistoryItem collection (Coleção chatMessageHistoryItem ) | Lista de histórico de atividade de um item de mensagem, incluindo o tempo e as ações de modificação, como reaçãoAdded, 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. 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 utilizador da mensagem quando o bot envia uma mensagem em nome de um utilizador. |
| policyViolation | chatMessagePolicyViolation | Define as propriedades de uma violação de política definida por uma aplicação de prevenção de perda de dados (DLP). |
| reactions | chatMessageReaction collection | Reações para esta mensagem de chat (por exemplo, Gosto). |
| replyToId | cadeia de caracteres | Somente leitura. ID da mensagem de chat principal ou mensagem de chat raiz do tópico. (Aplica-se apenas a mensagens de chat em canais e não chats.) |
| assunto | string | O assunto da mensagem de chat, em texto simples. |
| summary | string | Texto de resumo da mensagem de chat que pode ser utilizado para notificações push e vistas de resumo ou vistas de contingência. Aplica-se apenas a mensagens de chat de canal e não a mensagens de chat numa conversa. |
| webUrl | cadeia de caracteres | Somente leitura. Ligação para a mensagem no Microsoft Teams. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| respostas | chatMessage collection | Respostas para uma mensagem especificada.
$expand Suporta mensagens de canal. |
| hostedContents | chatMessageHostedContent collection (coleção chatMessageHostedContent ) | Conteúdo numa mensagem alojada pelo Microsoft Teams , por exemplo, imagens ou fragmentos de código. |
Representação JSON
A representação JSON seguinte 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",
"onBehalfOf": {"@odata.type": "microsoft.graph.chatMessageFromIdentitySet"},
"policyViolation": {"@odata.type": "microsoft.graph.chatMessagePolicyViolation"},
"reactions": [{"@odata.type": "microsoft.graph.chatMessageReaction"}],
"replyToId": "String (identifier)",
"subject": "String",
"summary": "String",
"webUrl": "String"
}