Compartilhar via

Adicionar ações sugeridas a mensagens com a API do Bot Connector

  • Artigo

As ações sugeridas permitem ao bot apresentar botões que o usuário pode tocar para fornecer entrada. As ações sugeridas aparecem perto do compositor e aprimoram a experiência do usuário, permitindo que o usuário responda a uma pergunta ou faça uma seleção com um simples toque de um botão, em vez de ter que digitar uma resposta com um teclado. 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. Isso impede que o usuário toque em botões obsoletos em uma conversa e simplifica o desenvolvimento de bots.

Enviar ações sugeridas

Para adicionar ações sugeridas a uma mensagem, defina a propriedade suggestedActions do objeto Atividade para especificar a lista de objetos CardAction que representam os botões a serem apresentados ao usuário.

A solicitação a seguir envia uma mensagem que apresenta três ações sugeridas para o usuário. Nessa solicitação de exemplo, https://smba.trafficmanager.net/teams representa o URI base; o URI base das solicitações emitidas pelo bot pode ser diferente. Para obter detalhes sobre como definir o URI base, confira Referência de API.

POST https://smba.trafficmanager.net/teams/v3/conversations/abcd1234/activities/5d5cdc723
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
    "type": "message",
    "from": {
        "id": "12345678",
        "name": "sender's name"
    },
    "conversation": {
        "id": "abcd1234",
        "name": "conversation's name"
   },
   "recipient": {
        "id": "1234abcd",
        "name": "recipient's name"
    },
    "text": "I have colors in mind, but need your help to choose the best one.",
    "inputHint": "expectingInput",
    "suggestedActions": {
        "actions": [
            {
                "type": "imBack",
                "title": "Blue",
                "value": "Blue"
            },
            {
                "type": "imBack",
                "title": "Red",
                "value": "Red"
            },
            {
                "type": "imBack",
                "title": "Green",
                "value": "Green"
            }
        ]
    },
    "replyToId": "5d5cdc723"
}

Quando o usuário tocar em uma das ações sugeridas, o bot receberá uma mensagem do usuário que contém o value da ação correspondente.

Recursos adicionais