Create prompt suggestions

To create prompt starters using Developer Portal:

1. Open Teams and select Apps from the left pane. In the Apps page, search for Developer Portal, and then select Open.

   

2. In Developer Portal, select the Apps tab. If you don't have an existing app package, you can create or import an existing app. For more information, see Developer Portal for Teams.

3. Select Apps tab, select App features from the left pane, and then select Bots.

4. Under Commands, select Add a command.

   

5. Enter the values for the following fields:

   • Command: Appears as the prompt for your bot.
   • Description: A brief explanation of the purpose of the command.

6. Select the personal scope and then select Add. This defines where the command menu must appear.

   

Another way to create a prompt starter is to create it directly in the app manifest file while developing your bot source code. To use this method, follow these points:

• The command property supports up to 10 commands.
• You can either create prompt starters that work in all scopes or create different prompt starters for each scope.

Manifest example for prompt starters

The manifest example code for prompt starters is as follows:

{
  ⋮
  "bots":[
    {
      "botId":"[Microsoft App ID for your bot]",
      "scopes": [
        "personal"
      ],
      "commandLists":[
        {
          "scopes":[
            "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"
            }
          ]
        }
      ]
    }
  ],
  ...
}

• SDK reference

• Sample code reference

You can parse out the @Mention portion of the message text using a static method provided with the Microsoft Bot Framework. It's a method of the Activity class named RemoveRecipientMention.

The C# code to parse out the @Mention portion of the message text is as follows:

// Remove recipient mention text from Text property.
// Use with caution because this function is altering the text on the Activity.
var modifiedText = turnContext.Activity.RemoveRecipientMention();

• SDK reference

• Sample code reference

You can parse out the @Mention portion of the message text using a static method provided with the Bot Framework. It's a method of the TurnContext class named removeMentionText.

The JavaScript code to parse out the @Mention portion of the message text is as follows:

// Remove mention text from Text property, this function is altering the text on the Activity.
const modifiedText = TurnContext.removeMentionText(turnContext.activity, turnContext.activity.recipient.id);

• SDK reference

• Sample code reference

You can parse out the @Mention portion of the message text using a static method provided with the Bot Framework. It's a method of the TurnContext class named remove_recipient_mention.

The Python code to parse out the @Mention portion of the message text is as follows:

# Remove recipient mention text from Text property, this function is altering the text on the Activity.
modified_text = TurnContext.remove_recipient_mention(turn_context.activity)

Desktop:

Mobile:

Desktop:

Mobile:

To add suggested actions to a message, specify a list of card action objects that represent the buttons to be displayed to the user for the suggestedActions property of the activity object.

The following is an example to implement suggested actions using imBack:

{
  "type": "message",
  "from": {
    "id": "12345678",
    "name": "sender's name"
  },
  "conversation": {
    "id": "abcd1234",
    "name": "conversation's name"
  },
  "recipient": {
    "id": "1234abcd",
    "name": "recipient's name"
  },
  "text": "What are the tasks for the day.",
  "inputHint": "expectingInput",
  "suggestedActions": {
    "actions": [
      {
        "type": "imBack",
        "title": "Create a new query identifying overdue tasks",
        "value": "Create a new query identifying overdue tasks"
      },
      {
        "type": "imBack",
        "title": "Create a new work item for this feature",
        "value": "Create a new work item for this feature"
            }
        ]
    },
  "replyToId": "5d5cdc723"
}

You can use the Action.Compose to insert a message in the compose box, which helps you add a new action type. This action enables you to include semantic objects like tags, mention users in the chat or channel, and other rich objects like emojis and gifs.

The following code snippet shows an example of implementing Action.Compose:

{ 
   Type: “Action.Compose”, 
   Title: “button title”, 
   Value: { 
      type: “Teams.chatMessage”, 
      data: <GraphAPI Chat Message Object> 
   } 
}

The value object must follow the chatMessage object in the Graph API.

For more information, see code sample.