Criar mensagens com a API do Bot Connector

Artigo
03/08/2023

Seu bot enviará objetos Atividade do tipo message para comunicar informações aos usuários e, da mesma forma, também receberá atividades message dos usuários. Algumas mensagens podem simplesmente consistir em texto sem formatação, enquanto outras podem conter conteúdo mais elaborado, como texto a ser falado, ações sugeridas, anexos de mídia, cartões avançados e dados específicos do canal. Este artigo descreve algumas das propriedades de mensagem comumente usadas.

Texto e formatação da mensagem

O texto da mensagem pode ser formatado usando texto sem formatação, markdown ou xml. O formato padrão da propriedade textFormat é markdown, e interpreta o texto usando padrões de formatação Markdown. O nível de suporte ao formato de texto varia entre os canais.

Dica

Para obter informações sobre quais recursos têm suporte em cada canal, consulte o artigo de referência de canais .

A propriedade textFormat do objeto Atividade pode ser usada para especificar o formato do texto. Por exemplo, para criar uma mensagem básica que contém apenas texto sem formatação, defina a propriedade textFormat do objeto Activity como sem formatação, defina a propriedade text do conteúdo da mensagem e defina a propriedade locale da localidade do remetente.

Anexos

A propriedade attachments do objeto Atividade pode ser usada para enviar anexos de mídia simples (imagem, áudio, vídeo, arquivo) e cartões avançados. Para obter detalhes, confira Adicionar anexos de mídia às mensagens e Adicionar cartões avançados às mensagens.

Entidades

A propriedade entities do objeto Atividade é uma matriz de objetos schema.org abertos que permite a troca de metadados contextuais comuns entre o canal e o bot.

Entidades de menção

Vários canais dão suporte à capacidade de um usuário ou bot "mencionar" alguém dentro do contexto de uma conversa. Para mencionar um usuário em uma mensagem, preencha a propriedade entities da mensagem com um objeto Mention.

Entidades Place

Para transmitir informações relacionadas à localização em uma mensagem, preencha a propriedade da entities mensagem com objetos Place .

Dados do canal

A propriedade channelData de um objeto Atividade pode ser usada para implementar a funcionalidade específica do canal. Para ver detalhes, confira Implementar a funcionalidade específica do canal.

Texto em fala

A propriedade speak do objeto Atividade pode ser usada para especificar o texto a ser falado pelo seu bot em um canal habilitado para fala e a propriedade inputHint do objeto Activity pode ser usada para influenciar o estado do microfone do cliente. Para obter detalhes, consulte Adicionar fala às mensagens e Adicionar dicas de entrada às mensagens.

Ações sugeridas

A propriedade suggestedActions de um objeto Atividade pode ser usada para apresentar os botões nos quais o usuário pode tocar para fornecer entradas. Ao contrário de botões exibidos em cartões avançados (que permanecem visíveis e acessíveis ao usuário, mesmo após serem tocados), os botões que aparecem no painel de ações sugeridas desaparecerão após a seleção do usuário. Para ver detalhes, confira Adicionar ações sugeridas a mensagens.

Compartilhar via