Get message

Recupere uma mensagem específica de um chat ou canal do Microsoft Teams usando a API GetChannelMessage ou GetChatMessage.

Visão geral

A atividade Get Message chama a API GetChannelMessage ou GetChatMessage do Microsoft Graph para recuperar uma mensagem especificada (MessageId) de um chat (ChatId) ou canal (ChannelId) e equipe (TeamID).

Após realizar a pesquisa, a atividade gera suas propriedades em um objeto ChatMessage (Message) que você pode usar como variáveis de entrada em atividades subsequentes (por exemplo, ChatMessage.Id em Get Message Replies, Reply To Message, e assim por diante).

A diferença entre essa atividade e a atividade Get Messages é o requisito de entrada de uma mensagem específica (MessageId). A entrada do MessageId permite que você recupere um objeto ChatMessage específico em vez de uma matriz de objetos que é retornado na atividade Get Messages .

Como funciona

As etapas a seguir e o diagrama de sequência de mensagens são um exemplo de como a atividade funciona desde o tempo de design (ou seja, as dependências da atividade e as propriedades de entrada/saída) até o tempo de execução.

1. Conclua as etapas de Configuração .
2. Adicione a atividade Microsoft Teams Scope ao seu projeto.
3. Complete one of the following two options (A or B):

A. Adicione uma atividade ou execute um processo externo que gere um valor Chat.Id (por exemplo, Get Chats).

B. Adicione uma atividade ou execute um processo externo que gere um valor Team.Id (por exemplo, Get Teams) E uma atividade ou processo externo que gere um valor Channel.Id (por exemplo, Get Channels).

1. Adicione a atividade Get Message dentro da atividade Microsoft Teams Scope .
2. Insira valores para as propriedades Channel OR Chat e Input .
3. Crie e insira uma variável ChatMessage para sua propriedade Saída .
4. Execute a atividade.

   • Seus valores de propriedade de entrada são enviados para a API GetChannelMessage ou GetChatMessage .

   • A API retorna o valor ChatMessage para sua variável de propriedade de saída.

     

Propriedades

Os valores para as seguintes propriedades são especificados ao adicionar esta atividade ao seu projeto no UiPath Studio.

Comum

NomeDeExibição

O nome de exibição da atividade.

Atributos	Detalhes
Tipo	String
Required	Sim
Valor padrão	Get Messages
Valores permitidos	Insira uma variável String ou String .
Observações	N/A

Canal

Id da equipe

O ID do objeto Team que contém o canal do qual você quer obter mensagens.

Atributos	Detalhes
Tipo	String
Required	Sim (se ChatId estiver vazio)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Team.Id , use um processo ou atividade externa que inclua o valor Team.Id em sua saída (por exemplo, Obter equipes ou chamada de API externa) (ChatId) ou (TeamId e ChannelId) são necessários.

ID do canal

O ID do objeto Channel do qual você deseja obter a mensagem.

Atributos	Detalhes
Tipo	String
Required	Sim (se IdDaEquipe tiver um valor)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Channel.Id , use um processo ou atividade externa que inclua o valor Channel.Id em sua saída (por exemplo, Obter canais ou chamada de API externa) (ChatId) ou (TeamId e ChannelId) são necessários.

Chat

ChatId

O ID do objeto Chat o qual você quer enviar a mensagem.

Atributos	Detalhes
Tipo	String
Required	Sim (se TeamId e ChannelId estiverem em branco)
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Chat.Id , use um processo ou atividade externa que inclua o valor Chat.Id em sua saída (por exemplo, Obter chats ou chamada de API externa) O (ChatId) ou (TeamId e ChannelId) são necessários.

Entrada

IdDaMensagem

O ID da mensagem que você deseja recuperar.

Atributos	Detalhes
Tipo	String
Required	Sim
Valor padrão	Vazio
Valores permitidos	Insira uma variável String ou String .
Observações	Para obter o valor Message.Id , use um processo ou atividade externa que inclua o valor Message.Id em sua saída (por exemplo, Obter mensagens ou chamada de API externa).

Diversos

Particular

Se selecionado, os valores das variáveis e argumentos não são mais registrados no nível Verbose.

Atributos	Detalhes
Tipo	Caixa de seleção
Required	Não
Valor padrão	não selecionado
Valores permitidos	Selecionado ou Não Selecionado
Observações	N/A

Saída

Mensagem

O objeto ChatMessage que representa a mensagem especificada na propriedade IdDaMensagem .

Atributos	Detalhes
Tipo	ChatMessage
Required	Não (necessário se você planejar usar os dados de saída em atividades subsequentes)
Valor padrão	Vazio
Valores permitidos	Insira uma variável ChatMessage .
Observações	A variável que você criar para essa propriedade pode ser usada como uma variável de entrada em atividades subsequentes (por exemplo, Obter respostas de mensagem , Responder a mensagem etc.). O objeto ChatMessage inclui várias propriedades que você pode usar em outras atividades. A imagem de exemplo abaixo mostra algumas das propriedades que você pode retornar. Observação: algumas propriedades listadas no designer não são aplicáveis ao objeto ChatMessage (por exemplo, ODatatType ). Para uma lista das propriedades Team aplicáveis, acesse os links acima.

Exemplo

A imagem a seguir mostra um exemplo do relacionamento de dependência de atividade e valores de propriedade de entrada/saída.

Para obter instruções passo a passo e exemplos, consulte os guias de Início rápido .