Adicionar um menu de bot no Microsoft Teams

Importante

Este artigo é baseado no SDK do Bot Framework v3. Se você estiver procurando a documentação atual versão 4.6 ou posterior do SDK, consulte a seção bots de conversação .

Para ajudar na descoberta e para ajudar a educar os usuários sobre a funcionalidade do bot, agora você pode adicionar menus que aparecem sempre que o usuário interage com seu bot. O menu mostrará o texto de comando e também fornecerá texto de ajuda, como um exemplo de uso ou descrição da finalidade do comando.

Captura de tela do menu bot

Quando um usuário seleciona um item de menu, a cadeia de caracteres de comando é inserida na caixa de texto para ajudar na conclusão do usuário da mensagem do bot.

Suporte ao menu bot no aplicativo móvel do Teams

Observação

Os menus do bot não são exibidos em dispositivos móveis.

Manifesto do aplicativo

Para criar um menu de bot, adicione um novo commandLists objeto ao manifesto do aplicativo na seção bot. Você pode declarar menus individuais com comandos separados para cada escopo que o bot dá suporte (personal, groupChatou team) Cada menu dá suporte a até 10 comandos.

Trecho de manifesto – menu único para ambos os escopos

{
  ⋮
  "bots":[
    {
      "botId":"[Microsoft App ID for your bot]",
      "scopes": [
        "personal",
        "team"
      ],
      "commandLists":[
        {
          "scopes":[
            "team",
            "personal"
          ],
          "commands":[
            {
              "title":"Help",
              "description":"Displays this help message"
            },
            {
              "title":"Search Flights",
              "description":"Search flights from Seattle to Phoenix May 2-5 departing after 3pm"
            },
            {
              "title":"Search Hotels",
              "description":"Search hotels in Portland tonight"
            },
            {
              "title":"Best Time to Fly",
              "description":"Best time to fly to London for a 5 day trip this summer"
            }
          ]
        }
      ]
    }
  ],
  ...
}

Trecho do manifesto – menu separado por escopo

{
  ...
  "bots":[
    {
      "botId":"[Microsoft app ID for your bot]",
      "scopes": [
        "groupChat",
        "team"
      ],
      "commandLists":[
        {
          "scopes":[
            "team"
          ],
          "commands":[
            {
            "title":"help",
            "description":"Displays this help message for channels"
            }
          ]
        },
        {
          "scopes":[
            "groupChat"
          ],
          "commands":[
            {
            "title":"help",
            "description":"Displays this help message for group chat"
            }
          ]
        }
      ]
    }
  ],
  ...
}

Práticas recomendadas

  • Mantenha-o simples: o menu do bot destina-se a apresentar os principais recursos do bot.
  • Mantenha-o curto: as opções de menu não devem ser instruções de linguagem natural extremamente longas e complexas - elas devem ser comandos simples.
  • Sempre disponível: ações/comandos de menu de bot devem ser sempre invocáveis, independentemente do estado da conversa ou da caixa de diálogo em que o bot está.