Use button for input

APPLIES TO: SDK v4

Buttons enhance the conversational experience by letting the user answer a question or select the desired button, rather than having to type a response with a keyboard. Unlike buttons that appear within rich cards (which remain visible and accessible to the user even after being selected), buttons that appear within the suggested actions pane will disappear after the user makes a selection. This prevents the user from selecting stale buttons within a conversation and simplifies bot development since you won't need to account for that scenario.

Note

The Bot Framework JavaScript, C#, and Python SDKs will continue to be supported, however, the Java SDK is being retired with final long-term support ending in November 2023. Only critical security and bug fixes within this repository will be undertaken.

Existing bots built with the Java SDK will continue to function.

For new bot building, consider using Power Virtual Agents and read about choosing the right chatbot solution.

For more information, see The future of bot building.

Suggest action using button

Suggested actions enable your bot to present buttons. You can create a list of suggested actions (also known as quick replies) that will be shown to the user for a single turn of the conversation.

C#

Here's an example from the Suggested actions sample.

// Creates and sends an activity with suggested actions to the user. When the user
// clicks one of the buttons the text value from the "CardAction" will be
// displayed in the channel just as if the user entered the text. There are multiple
// "ActionTypes" that may be used for different situations.
private static async Task SendSuggestedActionsAsync(ITurnContext turnContext, CancellationToken cancellationToken)
{
    var reply = MessageFactory.Text("What is your favorite color?");

    reply.SuggestedActions = new SuggestedActions()
    {
        Actions = new List<CardAction>()
        {
            new CardAction() { Title = "Red", Type = ActionTypes.ImBack, Value = "Red", Image = "https://via.placeholder.com/20/FF0000?text=R", ImageAltText = "R" },
            new CardAction() { Title = "Yellow", Type = ActionTypes.ImBack, Value = "Yellow", Image = "https://via.placeholder.com/20/FFFF00?text=Y", ImageAltText = "Y" },
            new CardAction() { Title = "Blue", Type = ActionTypes.ImBack, Value = "Blue", Image = "https://via.placeholder.com/20/0000FF?text=B", ImageAltText = "B" },
        },
    };
    await turnContext.SendActivityAsync(reply, cancellationToken);
}

JavaScript

Here's an example from the Suggested actions sample.

/**
 * Send suggested actions to the user.
 * @param {TurnContext} turnContext A TurnContext instance containing all the data needed for processing this conversation turn.
 */
async sendSuggestedActions(turnContext) {
    const cardActions = [
        {
            type: ActionTypes.PostBack,
            title: 'Red',
            value: 'Red',
            image: 'https://via.placeholder.com/20/FF0000?text=R',
            imageAltText: 'R'
        },
        {
            type: ActionTypes.PostBack,
            title: 'Yellow',
            value: 'Yellow',
            image: 'https://via.placeholder.com/20/FFFF00?text=Y',
            imageAltText: 'Y'
        },
        {
            type: ActionTypes.PostBack,
            title: 'Blue',
            value: 'Blue',
            image: 'https://via.placeholder.com/20/0000FF?text=B',
            imageAltText: 'B'
        }
    ];

    var reply = MessageFactory.suggestedActions(cardActions, 'What is the best color?');
    await turnContext.sendActivity(reply);
}

Java

Here's an example from the Suggested actions sample.

/**
 * Creates and sends an activity with suggested actions to the user. When the user
 * clicks one of the buttons the text value from the "CardAction" will be
 * displayed in the channel just as if the user entered the text. There are multiple
 * "ActionTypes" that may be used for different situations.
 */
private static CompletableFuture<Void> sendSuggestedActions(TurnContext turnContext) {
    Activity reply = MessageFactory.text("What is your favorite color?");

    CardAction redAction = new CardAction();
    redAction.setTitle("Red");
    redAction.setType(ActionTypes.IM_BACK);
    redAction.setValue("Red");
    redAction.setImage("https://via.placeholder.com/20/FF0000?text=R");
    redAction.setImageAltText("R");

    CardAction yellowAction = new CardAction();
    yellowAction.setTitle("Yellow");
    yellowAction.setType(ActionTypes.IM_BACK);
    yellowAction.setValue("Yellow");
    yellowAction.setImage("https://via.placeholder.com/20/FFFF00?text=Y");
    yellowAction.setImageAltText("Y");

    CardAction blueAction = new CardAction();
    blueAction.setTitle("Blue");
    blueAction.setType(ActionTypes.IM_BACK);
    blueAction.setValue("Blue");
    blueAction.setImage("https://via.placeholder.com/20/0000FF?text=B");
    blueAction.setImageAltText("B");

    SuggestedActions actions = new SuggestedActions();
    actions.setActions(Arrays.asList(redAction, yellowAction, blueAction));
    reply.setSuggestedActions(actions);
    return turnContext.sendActivity(reply).thenApply(sendResult -> null);
}

Python

Here's an example from the Suggested actions sample.

async def _send_suggested_actions(self, turn_context: TurnContext):
    """
    Creates and sends an activity with suggested actions to the user. When the user
    clicks one of the buttons the text value from the "CardAction" will be displayed
    in the channel just as if the user entered the text. There are multiple
    "ActionTypes" that may be used for different situations.
    """

    reply = MessageFactory.text("What is your favorite color?")

    reply.suggested_actions = SuggestedActions(
        actions=[
            CardAction(
                title="Red",
                type=ActionTypes.im_back,
                value="Red",
                image="https://via.placeholder.com/20/FF0000?text=R",
                image_alt_text="R",
            ),
            CardAction(
                title="Yellow",
                type=ActionTypes.im_back,
                value="Yellow",
                image="https://via.placeholder.com/20/FFFF00?text=Y",
                image_alt_text="Y",
            ),
            CardAction(
                title="Blue",
                type=ActionTypes.im_back,
                value="Blue",
                image="https://via.placeholder.com/20/0000FF?text=B",
                image_alt_text="B",
            ),
        ]
    )

    return await turn_context.send_activity(reply)

Additional resources

You can access the complete source code for the Suggested actions sample in C#, JavaScript, Java and Python.

Next steps

Save user and conversation data