# Bots.Business API v2 ## Docs - Root [BB Api docs](https://dev.bots.business/bb-api-docs-1724370m0.md): ## API Docs - Root > Authentication [Sign in](https://dev.bots.business/sign-in-23599798e0.md): Use this endpoin to login your bots business account and obtain credentials, only the headers you will need to make each request and obtaine your **api_key**. - Root > Authentication [Get Telegram login URL](https://dev.bots.business/get-telegram-login-url-23599799e0.md): Send a post request to this endpoint to get an telegram login url, then you can redirect user to the url and confirm login using sign in enpoint, you do not have to post any data to this endpoint - Root > Authentication [Sign up](https://dev.bots.business/sign-up-23599800e0.md): Use this endpoint to register new users on [Bots.Business](https://bots.business) platform - Root > Authentication [Telegram login](https://dev.bots.business/telegram-login-23599801e0.md): Use this enpoint to login using telegram telegram, use the secret you generated from get telegram login url endpoint, - Root > Authentication [Reset Password](https://dev.bots.business/reset-password-23599802e0.md): Ues this endpoint to get a fresh password in your mail box - Root > User account [Update password](https://dev.bots.business/update-password-23599803e0.md): USe this endpoint to update user password - Root > User account [Get user details](https://dev.bots.business/get-user-details-23599804e0.md): Use this enpoin to get user details includng **api_key** which an be used to send request to othe rendpoints. - Root > User account [Update email](https://dev.bots.business/update-email-23599805e0.md): Use this endpoint to update you user emal address. - Root > User account [Get linked telegram accounts](https://dev.bots.business/get-linked-telegram-accounts-23599806e0.md): Use this endpoint to get linked telegram accounts. Those accounts user linked with bots business - Root > User account [Get telegram link url](https://dev.bots.business/get-telegram-link-url-23599807e0.md): Use this endpoint to link new telegram id with user bb account - Root > User account [Get users session token](https://dev.bots.business/get-users-session-token-23599808e0.md): Use this endpoint to get use session tokens, This will show how many active logins user have. - Root > User account [Reset api key](https://dev.bots.business/reset-api-key-23599809e0.md): Use this endpoint to reset user api_key, no need to send any data in post - Root > User account [Log out all device](https://dev.bots.business/log-out-all-device-23599810e0.md): Use this endpoint to clear all session and log them out. - Root > User account [Get iteration usage](https://dev.bots.business/get-iteration-usage-23599811e0.md): Use this endpoint to retrieve detailed information about your iteration usage, including consumption statistics and remaining limits. - Root > User account [Turn ON or OFF ads](https://dev.bots.business/turn-on-or-off-ads-23599812e0.md): Use this endpoint to enable or disable advertisements in your bot. When ads are enabled, you receive increased iteration limits and potential earnings, but advertisements will be displayed to your bot's users. - Root > User account [Get payment plan](https://dev.bots.business/get-payment-plan-23599813e0.md): Use this endpoint to retrieve detailed information about your current subscription or payment plan, including billing details, features, and status. - Root > Bots [Create Bot](https://dev.bots.business/create-bot-23599814e0.md): Use this endpoint to create a new bot. - Root > Bots [Get Bots](https://dev.bots.business/get-bots-23599815e0.md): Use this endpoint to get list of your bots. - Root > Bots [Get single bot](https://dev.bots.business/get-single-bot-23599816e0.md): Get a single bot details - Root > Bots [Edit Bot](https://dev.bots.business/edit-bot-23599817e0.md): Use this endpoint to edit an existing bot. - Root > Bots [Delete Bot](https://dev.bots.business/delete-bot-23599818e0.md): Use this endpoint to permanently delete a bot and all its associated data. This action cannot be undone. - Root > Bots [Start or Stop bot](https://dev.bots.business/start-or-stop-bot-23599819e0.md): Use this endpoint to start or stop a bot runtime process. - Root > Bots [Start CSV import](https://dev.bots.business/start-csv-import-23599820e0.md): Use this endpoint to start importing bot commands from csv - Root > Bots [CSV import task status](https://dev.bots.business/csv-import-task-status-23599821e0.md): Use this endpoint to checl csv import status - Root > Bots [Copy Bot](https://dev.bots.business/copy-bot-23599822e0.md): Use this endpoint to make a copy of your bot. - Root > Bots [Git export](https://dev.bots.business/git-export-23599823e0.md): USe this endpoint to start exporting bot from github repository, - Root > Bots [Git import](https://dev.bots.business/git-import-23599824e0.md): Use thi endpoint to import bot from github repository. - Root > Bots [Get installed libraries](https://dev.bots.business/get-installed-libraries-23599825e0.md): Use this endpoint to install a library onto your bot. Once installed, the library's functionality will be available for use in your bot's commands . - Root > Bots [Install Lib](https://dev.bots.business/install-lib-23599826e0.md): - Root > Bots [Uninstall lib](https://dev.bots.business/uninstall-lib-23599827e0.md): Use this endpoint to uninstall a library from your bot. This will remove the library's functionality and make its features unavailable for your bot's commands. - Root > Bots [Get error log](https://dev.bots.business/get-error-log-23599828e0.md): Use this endpoint to retrieve error logs for your bot. The response will contain detailed information about any errors that have occurred, including timestamps and error messages. - Root > Bots [Clear error logs](https://dev.bots.business/clear-error-logs-23599829e0.md): Use this endpoint to permanently clear all error logs from your bot's history. This action cannot be undone. - Root > Commands > Folders [Create a folder](https://dev.bots.business/create-a-folder-23599835e0.md): - Root > Commands > Folders [Get all folders](https://dev.bots.business/get-all-folders-23599836e0.md): Get list of command folders - Root > Commands > Folders [Delete a folder](https://dev.bots.business/delete-a-folder-23599837e0.md): Use tis endpoint to delete an existing folder - Root > Commands [Get Commands](https://dev.bots.business/get-commands-23599830e0.md): Use this endpoint to get all the commands. - Root > Commands [Create Command](https://dev.bots.business/create-command-23599831e0.md): Use this endpoint to create a new command for a specific bot. - Root > Commands [Get Command Details](https://dev.bots.business/get-command-details-23599832e0.md): Use this endpoint to ge a single command - Root > Commands [Edit Command](https://dev.bots.business/edit-command-23599833e0.md): Use this endpoint to update an existing command. - Root > Commands [Delete Command](https://dev.bots.business/delete-command-23599834e0.md): Use this endpoint to delete a command - Root > Broadcast [Get broadcast tasks](https://dev.bots.business/get-broadcast-tasks-23599838e0.md): Use this endpoints to get active and completed broadcast tasks - Root > Broadcast [Delete Broadcast task](https://dev.bots.business/delete-broadcast-task-23599839e0.md): Use this endpoint to permanently delete an existing broadcast task from the system. - Root > Broadcast [Pause broadcast task](https://dev.bots.business/pause-broadcast-task-23599840e0.md): Use this endpoint to pasue an existing broadcast task. - Root > Broadcast [Resume broadcast task](https://dev.bots.business/resume-broadcast-task-23599841e0.md): Use this endpoint to resume a previously paused broadcast task. - Root > Chats [Get chats](https://dev.bots.business/get-chats-23599842e0.md): Use this endpoint to get private and group chats - Root > Chats [Block chat](https://dev.bots.business/block-chat-23599843e0.md): Use this endpoint to block a specific chat from receiving messages. Once blocked, your bot will no longer receive updates or messages from that chat. - Root > Chats [Unblock chat](https://dev.bots.business/unblock-chat-23599844e0.md): Use this endpoint to unblock a chat that was previously blocked. This will restore the bot's ability to receive updates and send messages to that chat. - Root > Properties [Get properties](https://dev.bots.business/get-properties-23599845e0.md): Use this endpoint to retrieve a list of properties created for your bot or for any specific users. - Root > Properties [Delete property](https://dev.bots.business/delete-property-23599846e0.md): Use this endpoint to permanently delete a specific property from the system. - Root > Libraries [Get libraries](https://dev.bots.business/get-libraries-23599847e0.md): Use this endpoint to retrieve a list of available libraries that can be installed for your bot. - Root > Admin Panel [Get admin panels](https://dev.bots.business/get-admin-panels-23599848e0.md): Use this endpoint to retrieve a list of all available admin panels for your bot configuration and management. - Root > Admin Panel [Update admin panel values](https://dev.bots.business/update-admin-panel-values-23599849e0.md): Use this endpoint to update the values of specific fields within an admin panel. This allows you to modify configuration settings and panel properties. - Root > Demo Store [Get store bots](https://dev.bots.business/get-store-bots-23599850e0.md): Use this endpoint to retrieve a list of demo bots available for installation. These pre-configured bots can help you quickly get started with various functionalities. - Root > Demo Store [Install demo bot](https://dev.bots.business/install-demo-bot-23599851e0.md): Use this endpoint to install a demo bot from the demo store. This will create a copy of the selected demo bot in your account with all its pre-configured commands and settings. - Root [Get cloud plans](https://dev.bots.business/get-cloud-plans-23599797e0.md): Use this endpoint to retrieve the available cloud hosting plans and their specifications from the server. ## Schemas - Root [Command Schema](https://dev.bots.business/command-schema-10572477d0.md): - Root [User Public](https://dev.bots.business/user-public-10572478d0.md): - Root [Create & Edit Bot](https://dev.bots.business/create-edit-bot-10572479d0.md): - Root [Bot](https://dev.bots.business/bot-10572480d0.md):