root.bots object

Defines a bot solution, along with optional information such as default command properties.

Properties that reference this object type:

• root.bots

Syntax

Syntax

{
  "botId": "{string}",
  "configuration": {
    "team": {
      team object
    },
    "groupChat": {
      groupChat object
    }
  },
  "needsChannelSelector": {boolean},
  "isNotificationOnly": {boolean},
  "requiresSecurityEnabledGroup": {boolean},
  "supportsFiles": {boolean},
  "supportsCalling": {boolean},
  "supportsVideo": {boolean},
  "scopes": [
    "team | personal | groupChat"
  ],
  "commandLists": [
    {
      "scopes": [
        "team | personal | groupChat"
      ],
      "commands": [
        {
          commands object
        }
      ]
    }
  ],
  "requirementSet": {
    "hostMustSupportFunctionalities": [
      {
        hostFunctionality object
      }
    ]
  }
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "botId": {
      "$ref": "#/definitions/guid",
      "description": "The Microsoft App ID specified for the bot in the Bot Framework portal (https://dev.botframework.com/bots)"
    },
    "configuration": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "team": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "fetchTask": {
              "type": "boolean",
              "description": "A boolean value that indicates if it should fetch bot config task module dynamically.",
              "default": false
            },
            "taskInfo": {
              "$ref": "#/definitions/taskInfo",
              "description": "Task module to be launched when fetch task set to false."
            }
          }
        },
        "groupChat": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "fetchTask": {
              "type": "boolean",
              "description": "A boolean value that indicates if it should fetch bot config task module dynamically.",
              "default": false
            },
            "taskInfo": {
              "$ref": "#/definitions/taskInfo",
              "description": "Task module to be launched when fetch task set to false."
            }
          }
        }
      }
    },
    "needsChannelSelector": {
      "type": "boolean",
      "description": "This value describes whether or not the bot utilizes a user hint to add the bot to a specific channel.",
      "default": false
    },
    "isNotificationOnly": {
      "type": "boolean",
      "description": "A value indicating whether or not the bot is a one-way notification only bot, as opposed to a conversational bot.",
      "default": false
    },
    "requiresSecurityEnabledGroup": {
      "type": "boolean",
      "description": "A value indicating whether the team\u0027s Office group needs to be security enabled.",
      "default": false
    },
    "supportsFiles": {
      "type": "boolean",
      "description": "A value indicating whether the bot supports uploading/downloading of files.",
      "default": false
    },
    "supportsCalling": {
      "type": "boolean",
      "description": "A value indicating whether the bot supports audio calling.",
      "default": false
    },
    "supportsVideo": {
      "type": "boolean",
      "description": "A value indicating whether the bot supports video calling.",
      "default": false
    },
    "scopes": {
      "type": "array",
      "description": "Specifies whether the bot offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive.",
      "maxItems": 3,
      "items": {
        "enum": [
          "team",
          "personal",
          "groupChat"
        ]
      }
    },
    "commandLists": {
      "type": "array",
      "maxItems": 3,
      "description": "The list of commands that the bot supplies, including their usage, description, and the scope for which the commands are valid. A separate command list should be used for each scope.",
      "items": {
        "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"
        ]
      }
    },
    "requirementSet": {
      "$ref": "#/definitions/elementRequirementSet",
      "description": "The set of requirements for the bot."
    }
  },
  "required": [
    "botId",
    "scopes"
  ]
}

Syntax

{
  "botId": "{string}",
  "configuration": {
    "team": {
      team object
    },
    "groupChat": {
      team object
    }
  },
  "needsChannelSelector": {boolean},
  "isNotificationOnly": {boolean},
  "supportsFiles": {boolean},
  "supportsCalling": {boolean},
  "supportsVideo": {boolean},
  "scopes": [
    "team | personal | groupChat"
  ],
  "commandLists": [
    {
      "scopes": [
        "team | personal | groupChat"
      ],
      "commands": [
        {
          commands object
        }
      ]
    }
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "botId": {
      "$ref": "#/definitions/guid",
      "description": "The Microsoft App ID specified for the bot in the Bot Framework portal (https://dev.botframework.com/bots)"
    },
    "configuration": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "team": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "fetchTask": {
              "$ref": "#/properties/composeExtensions/items/properties/commands/items/properties/fetchTask"
            },
            "taskInfo": {
              "$ref": "#/properties/composeExtensions/items/properties/commands/items/properties/taskInfo"
            }
          }
        },
        "groupChat": {
          "$ref": "#/properties/bots/items/properties/configuration/properties/team"
        }
      }
    },
    "needsChannelSelector": {
      "type": "boolean",
      "description": "This value describes whether or not the bot utilizes a user hint to add the bot to a specific channel.",
      "default": false
    },
    "isNotificationOnly": {
      "type": "boolean",
      "description": "A value indicating whether or not the bot is a one-way notification only bot, as opposed to a conversational bot.",
      "default": false
    },
    "supportsFiles": {
      "type": "boolean",
      "description": "A value indicating whether the bot supports uploading/downloading of files.",
      "default": false
    },
    "supportsCalling": {
      "type": "boolean",
      "description": "A value indicating whether the bot supports audio calling.",
      "default": false
    },
    "supportsVideo": {
      "type": "boolean",
      "description": "A value indicating whether the bot supports video calling.",
      "default": false
    },
    "scopes": {
      "type": "array",
      "description": "Specifies whether the bot offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive.",
      "maxItems": 3,
      "items": {
        "enum": [
          "team",
          "personal",
          "groupChat"
        ]
      }
    },
    "commandLists": {
      "type": "array",
      "maxItems": 3,
      "description": "The list of commands that the bot supplies, including their usage, description, and the scope for which the commands are valid. A separate command list should be used for each scope.",
      "items": {
        "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"
        ]
      }
    }
  },
  "required": [
    "botId",
    "scopes"
  ]
}

Properties

botId

The Microsoft App ID specified for the bot in the Bot Framework portal (https://dev.botframework.com/bots)

Type
string

Required
✅

Constraints

Supported values
The string value must be a guid.

configuration

Represents configuration information for the given scope of the bot.

Type
configuration

Required
—

Constraints

Supported values

needsChannelSelector

This value describes whether or not the bot utilizes a user hint to add the bot to a specific channel.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

isNotificationOnly

A value indicating whether or not the bot is a one-way notification only bot, as opposed to a conversational bot.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

requiresSecurityEnabledGroup

A value indicating whether the team's Office group needs to be security enabled.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

supportsFiles

A value indicating whether the bot supports uploading/downloading of files.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

supportsCalling

A value indicating whether the bot supports audio calling.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

supportsVideo

A value indicating whether the bot supports video calling.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

scopes

Specifies whether the bot offers an experience in the context of a channel in a team, in a 1:1 or group chat, or in an experience scoped to an individual user alone. These options are non-exclusive.

Type
Array of enum

Required
✅

Constraints
Maximum array items: 3.

Supported values
Allowed values: team, personal, groupChat.

commandLists

The list of commands that the bot supplies, including their usage, description, and the scope for which the commands are valid. A separate command list should be used for each scope.

Type
Array of commandLists

Required
—

Constraints
Maximum array items: 3.

Supported values

requirementSet

Runtime requirements for the bot to function properly in the Microsoft 365 host application. If one or more of the requirements aren't supported by the runtime host, the host won't load the bot.

Type
elementRequirementSet

Required
—

Constraints

Supported values

Remarks

The item is an array (maximum of only one element— only one bot is allowed per app) with all elements of the type object. This block is required only for solutions that provide a bot experience.

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"
                    }
                ]
            }
        ]
    ]
}