root.bots.commandLists.commands object

An optional list of commands that your bot can recommend to users. The object is an array (maximum of 3 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.commands

Syntax

Syntax

{
  "title": "{string}",
  "description": "{string}"
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "title": {
      "type": "string",
      "description": "The bot command name",
      "maxLength": 128
    },
    "description": {
      "type": "string",
      "description": "A simple text description or an example of the command syntax and its arguments.",
      "maxLength": 4000
    }
  },
  "required": [
    "title",
    "description"
  ]
}

Properties

title

The bot command name.

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 128.

Supported values

description

A simple text description or an example of the command syntax and its arguments.

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 4000.

Supported values

Examples

{
 "bots": [
        {
            "commandLists": [
                {
                    "commands": [
                        {
                            "title": "Personal command 1",
                            "description": "Description of Personal command 1"
                        },
                        {
                            "title": "Personal command N",
                            "description": "Description of Personal command N"
                        }
                    ]
                }
            ]
        }
    ]
}