Criar mensagens com a API do Conector do Bot

  • Artigo

O bot enviará a mensagemObjetos de atividade do tipo para comunicar informações aos utilizadores e, da mesma forma, também receberá atividades de mensagens dos utilizadores. Algumas mensagens podem consistir simplesmente em texto simples, enquanto outras podem conter conteúdos mais avançados, como texto a ser falado, ações sugeridas, anexos de multimédia, cartões avançados e dados específicos do canal. Este artigo descreve algumas das propriedades de mensagens mais utilizadas.

Texto e formatação da mensagem

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

Dica

Para obter informações sobre que funcionalidades são suportadas em cada canal, consulte o artigo de referência de canais .

A textFormat propriedade do objeto Atividade pode ser utilizada para especificar o formato do texto. Por exemplo, para criar uma mensagem básica que contenha apenas texto simples, defina a textFormat propriedade do Activity objeto como simples, defina a text propriedade para o conteúdo da mensagem e defina a locale propriedade para a região do remetente.

Anexos

A attachments propriedade do objeto Atividade pode ser utilizada para enviar anexos multimédia simples (imagem, áudio, vídeo, ficheiro) e cartões avançados. Para obter detalhes, consulte Adicionar anexos de multimédia a mensagens e Adicionar cartões avançados a mensagens.

Entidades

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

Mencionar entidades

Muitos canais suportam a capacidade de um bot ou utilizador "mencionar" alguém no contexto de uma conversação. Para mencionar um utilizador numa mensagem, preencha a propriedade da entities mensagem com um objeto Menção .

Colocar entidades

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

Dados de canal

A channelData propriedade do objeto Atividade pode ser utilizada para implementar funcionalidades específicas do canal. Para obter detalhes, veja Implementar funcionalidades específicas do canal.

Conversão de texto em voz

A speak propriedade do objeto Atividade pode ser utilizada para especificar o texto a ser falado pelo bot num canal com capacidade de voz e a inputHint propriedade do Activity objeto pode ser utilizada para influenciar o estado do microfone do cliente. Para obter detalhes, consulte Adicionar voz a mensagens e Adicionar sugestões de entrada a mensagens.

Ações sugeridas

A suggestedActions propriedade do objeto Atividade pode ser utilizada para apresentar botões que o utilizador pode tocar para fornecer entrada. Ao contrário dos botões que aparecem em cartões avançados (que permanecem visíveis e acessíveis para o utilizador mesmo depois de serem tocados), os botões que aparecem no painel de ações sugeridas desaparecerão depois de o utilizador efetuar uma seleção. Para obter detalhes, veja Adicionar ações sugeridas às mensagens.

Recursos adicionais