root.bots.commandLists object

A list of commands that your bot can recommend to users, including their usage, description, and the scope for which the commands are valid.. The object is an array (maximum of three elements) with all elements of type object; you must define a separate command list for each scope that your bot supports.

Properties that reference this object type:

• root.bots.commandLists

Syntax

Syntax

{
  "scopes": [
    "team | personal | groupChat"
  ],
  "commands": [
    {
      "title": "{string}",
      "description": "{string}"
    }
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "scopes": {
      "type": "array",
      "description": "Specifies the scopes for which the command list is valid",
      "maxItems": 3,
      "items": {
        "enum": [
          "team",
          "personal",
          "groupChat"
        ]
      }
    },
    "commands": {
      "type": "array",
      "maxItems": 10,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "title": {
            "type": "string",
            "description": "The bot command name",
            "maxLength": 32
          },
          "description": {
            "type": "string",
            "description": "A simple text description or an example of the command syntax and its arguments.",
            "maxLength": 128
          }
        },
        "required": [
          "title",
          "description"
        ]
      }
    }
  },
  "required": [
    "scopes",
    "commands"
  ]
}

Properties

scopes

Specifies the scope for which the command list is valid. Options are team, personal, and groupChat.

Type
Array of enum

Required
✅

Constraints
Maximum array items: 3.

Supported values
Allowed values: team, personal, groupChat.

commands

An array of commands the bot supports.

Type
Array of commands

Required
✅

Constraints
Maximum array items: 10.

Supported values

Remarks

Note

Teams mobile client doesn't support the bot app when there is no value in the commandLists property.

Examples

{
 "bots": [
        "commandLists": [
            {
                "scopes": [
                    "team",
                    "groupChat"
                ],
                "commands": [
                    {
                        "title": "Command 1",
                        "description": "Description of Command 1"
                    },
                    {
                        "title": "Command 2",
                        "description": "Description of Command 2"
                    }
                ]
            },
            {
                "scopes": [
                    "personal",
                    "groupChat"
                ],
                "commands": [
                    {
                        "title": "Personal command 1",
                        "description": "Description of Personal command 1"
                    },
                    {
                        "title": "Personal command N",
                        "description": "Description of Personal command N"
                    }
                ]
            }
        ]
    ]
}