Module bots_api

Enums

AssignBotError

struct for typed errors of method assign_bot

ConvertBotToUserError

struct for typed errors of method convert_bot_to_user

ConvertUserToBotError

struct for typed errors of method convert_user_to_bot

CreateBotError

struct for typed errors of method create_bot

DeleteBotIconImageError

struct for typed errors of method delete_bot_icon_image

DisableBotError

struct for typed errors of method disable_bot

EnableBotError

struct for typed errors of method enable_bot

GetBotError

struct for typed errors of method get_bot

GetBotIconImageError

struct for typed errors of method get_bot_icon_image

GetBotsError

struct for typed errors of method get_bots

PatchBotError

struct for typed errors of method patch_bot

SetBotIconImageError

struct for typed errors of method set_bot_icon_image

Functions

assign_bot

Assign a bot to a specified user. ##### Permissions Must have manage_bots permission. Minimum server version: 5.10

convert_bot_to_user

Convert a bot into a user. Minimum server version: 5.26 ##### Permissions Must have manage_system permission.

convert_user_to_bot

Convert a user into a bot. Minimum server version: 5.26 ##### Permissions Must have manage_system permission.

create_bot

Create a new bot account on the system. Username is required. ##### Permissions Must have create_bot permission. Minimum server version: 5.10

delete_bot_icon_image

Delete bot’s LHS icon image based on bot_user_id string parameter. ##### Permissions Must have manage_bots permission. Minimum server version: 5.14

disable_bot

Disable a bot. ##### Permissions Must have manage_bots permission. Minimum server version: 5.10

enable_bot

Enable a bot. ##### Permissions Must have manage_bots permission. Minimum server version: 5.10

get_bot

Get a bot specified by its bot id. ##### Permissions Must have read_bots permission for bots you are managing, and read_others_bots permission for bots others are managing. Minimum server version: 5.10

get_bot_icon_image

Get a bot’s LHS icon image based on bot_user_id string parameter. ##### Permissions Must be logged in. Minimum server version: 5.14

get_bots

Get a page of a list of bots. ##### Permissions Must have read_bots permission for bots you are managing, and read_others_bots permission for bots others are managing. Minimum server version: 5.10

patch_bot

Partially update a bot by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have manage_bots permission. Minimum server version: 5.10

set_bot_icon_image

Set a bot’s LHS icon image based on bot_user_id string parameter. Icon image must be SVG format, all other formats are rejected. ##### Permissions Must have manage_bots permission. Minimum server version: 5.14