# Getting started How to start using Fullyst in your community ### Need help? Let us know! {% hint style="info" %} If you need some help, are stuck with something, or want to give us feedback, feel free to write us an email at {% endhint %} ### Add your chat to Fullyst In this part of our documentation, we will add the chat to Fullyst and configure it. 1. Go to our [website](https://fullyst.com/) 2. Press the button "Start using now" or simply send /start command to [@FullystBot](https://t.me/FullystBot) 3. Press the button "Add me to your group" below the message from the bot 4. Select the chat you want to add the bot to 5. Configure bot permissions (we recommend to add bot as an administrator, to use all functions) 6. Press the button "Add Bot as Admin" (or "Add Bot as Member", it depends of persmissions configuration)

Bot answer to the command /start

Permissions configuration

All set! Now your chat added and you can configure it! # Fullyst bot's commands List of available commands for the bot Common commands available for all users and chats: * /help - get the help message * /settings - configure the bot * /mystat - get your personal statistics * /stat - get statistics for chat or summary * /language - set a language for the bot * /privacy\_config - edit privacy mode for the website * /proxy - get out Telegram proxies * /reload, /update - clear all system caches to refresh information about the chat The following commands are available only if appropriate settings are enabled: {% hint style="info" %} Visit [the chat's settings](https://fullyst.com/my_chats) to configure it {% endhint %} * [/report](/fullyst-bots-commands/report) - send a report to the message for chat administrators * [/ban](/fullyst-bots-commands/ban) - ban user (should be used only by chat's administrators and as a reply to a message) * [/warn](/fullyst-bots-commands/warn-and-rm_warn) - increase warn level for a user (should be used only by chat's administrators and as a reply to a message) * [/rm\_warn](/fullyst-bots-commands/warn-and-rm_warn) - remove all warnings from the user (should be used only by chat's administrators and as a reply to a message) * [/warns\_list](/fullyst-bots-commands/warns_list) - list of warnings * /spam, /voteban - vote that the message is spam (should be used as a reply to a message) # /report Description and use the command /report Bot command /report is able users in your chat to send reports to the chat's moderators and/or administrators. It's a simple tool for the manual moderation of your community that will suit those who want to take the community themselves. ### Configuration of the command 1. Press the button "Chat settings" near the selected chat on the ["My chats" page](https://fullyst.com/my_chats) 2. Open "Moderation" settings by clicking the corresponding menu item 3. Enable /report command on the page and choose chat's moderators and administrators who will receive the reports

Moderation settings

### Command usage To send the report, users should send this command as a reply to the target message.

How to send a report to a message

When the report is sent, administrators and/or moderators selected in settings will receive the report message with the chat name and text of the reported message.

Received report

# /spam Bot's command `/spam` is about a community-driven moderation system. This command initializes voting if a message is spam or not. ## Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ## Command usage {% hint style="info" %} This command is available for all members of the chat {% endhint %} ### Simple usage Just send `/spam` as a reply to any message, the bot will send a voting message.
If chat members decide that the message is spam, the message will be removed and the user will be banned. Community moderators can unban the user later with the [/unban](/fullyst-bots-commands/unban) command or via chat settings. # /ban Description and use the command /ban Bot's command `/ban` is able moderators and administrators to ban users for a certain period or forever. {% hint style="info" %} Note. This command supports arguments! Read the following paragraphs for the details {% endhint %} {% hint style="success" %} Note. This command supports "quiet" mode. In this mode, your commands will be deleted, and members of your chat will not see any notifications\ To use "quiet" mode add "q" before the command (like /qban instead of /ban) {% endhint %} ## Configuration of the command * Press the button "Chat settings" near the selected chat on the ["My Chats" page](https://fullyst.com/my_chats) * Open "Moderation" settings by clicking the corresponding menu item * Enable `/ban` command on the page

Moderation settings

## Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} ### Simple usage Just send `/ban` as a reply to a message and the user will be banned and the message will be removed.

How to ban user in the chat

Or you may use the `/ban` command with one argument - the user mention:

How to ban user by mention

### Usage with arguments Command `/ban` supports the following arguments: * Length of the ban in minutes, hours, and days * "No-delete" mark which prevents to deletion of the message from the banned user * Reason - the reason that will be saved #### Ban a user by the mention `/ban ` Arguments for the /ban command in this case are: * `mention` (required) - any valid user mention (just type @ and then mention any user in your chat by username or by name) * `duration` (optional) - the period for which the user will be blocked. If not provided - the user will be banned forever\ Xm - X **m**inutes\ Xh - X **h**ours\ Xd - X **d**ays * `reason` (optional) - a reason for the ban will be saved and printed #### Ban a user by reply You can also ban a user by replying to their message with the ban command `/ban ` Arguments for the /bane command in this case are: * `duration` (optional) - the period for which the user will be blocked. If not provided - the user will be banned forever\ Xm - X **m**inutes\ Xh - X **h**ours\ Xd - X **d**ays * `delete` (optional) - if this argument is `no-delete`, the message you reply to won't be deleted * `reason` (optional) - a reason for the ban will be saved and printed Let's ban a user for 1 hour:

How to ban user for 1 hour

Now let's ban the user forever, but keep its message

How to ban user forever but keep message

Also, you may combine both arguments in any order. In the example below, we will ban the user for 5 days and keep its message

How to ban user for five days and keep its messages

# /unban Description and use the command /unban Bot's command `/unban` is able moderators and administrators to unban previously banned users. {% hint style="info" %} Note. This command supports arguments! Read the following paragraphs for the details. {% endhint %} {% hint style="success" %} Note. This command supports "quiet" mode. In this mode, your commands will be deleted, and members of your chat will not see any notifications\ To use "quiet" mode add "q" before the command (like /qunban instead of /unban) {% endhint %} ## Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ## Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} ### Simple usage Just send /unban as a reply to any user's message and the user you reply to will be unbanned. ### Usage with arguments Command `/unban` supports the following arguments: * Reason - the unban reason that will be saved #### Unban user by a mention `/unban ` Arguments for the `/unban` command in this case are: * `mention` (required) - any valid user mention (just type @ and then mention any user banned in your chat by username or by name) * `reason` (optional) - a reason for the unban will be saved and printed #### Unban a user by reply You can also unban a user by replying to their message with the unban command `/unban ` Arguments for the `/unban` command in this case are: * `reason` (optional) - a reason for the unban will be saved and printed # /baninfo This command allows moderators to check information about the user's ban. {% hint style="warning" %} Attention! Response on this command may contain sensitive data! Consider using the command in private chat with the bot. {% endhint %} ### Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ### Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} Command `/baninfo` supports the following arguments: * username - the name of the user you want to get ban information to Example: `/baninfo @username` # /kick Description and use the command /kick Bot's command `/kick` is able moderators and administrators to kick users from the group without a ban. {% hint style="info" %} Note. This command supports arguments! Read the following paragraphs for the details. {% endhint %} {% hint style="success" %} Note. This command supports "quiet" mode. In this mode, your commands will be deleted, and members of your chat will not see any notifications\ To use "quiet" mode add "q" before the command (like /qkick instead of /kick) {% endhint %} ## Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ## Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} ### Simple usage Just send `/kick` as a reply to any user's message and the user you reply to will be kicked from the chat. ### Usage with arguments Command `/kick` supports the following arguments: * Reason - the kick reason that will be saved #### Kick user by a mention `/kick ` Arguments for the `/kick` command in this case are: * `mention` (required) - any valid user mention (just type @ and then mention any user in your chat by username or by name) * `reason` (optional) - a reason for the kick will be saved and printed #### Kick a user by reply You can also kick a user by replying to their message with the `/kick` command `/kick ` Arguments for the `/kick` command in this case are: * `reason` (optional) - a reason for the kick will be saved and printed # /mute Description and use the command /mute Bot's command `/mute` is able moderators and administrators to mute users of the group without a ban. {% hint style="info" %} Note. This command supports arguments! Read the following paragraphs for the details. {% endhint %} {% hint style="success" %} Note. This command supports "quiet" mode. In this mode, your commands will be deleted, and members of your chat will not see any notifications\ To use "quiet" mode add "q" before the command (like /qmute instead of /,ute) {% endhint %} ## Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ## Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} ### Simple usage Just send `/mute` as a reply to any user's message and the user you reply to will be muted forever. ### Usage with arguments Command `/mute` supports the following arguments: * `duration` (optional) - the period for which the user will be muted. If not provided - the user will be banned forever\ Xm - X **m**inutes\ Xh - X **h**ours\ Xd - X **d**ays * `reason` (optional) - a reason for the mute will be saved and printed #### Mute user by a mention `/mute ` Arguments for the `/mute` command in this case are: * `mention` (required) - any valid user mention (just type @ and then mention any user in your chat by username or by name) * `duration` (optional) - the period for which the user will be muted. If not provided - the user will be banned forever\ Xm - X **m**inutes\ Xh - X **h**ours\ Xd - X **d**ays * `reason` (optional) - a reason for the mute will be saved and printed #### Mute a user by reply You can also mute a user by replying to their message with the `/mute` command `/mute ` Arguments for the `/mute` command in this case are: * `duration` (optional) - the period for which the user will be muted. If not provided - the user will be banned forever\ Xm - X **m**inutes\ Xh - X **h**ours\ Xd - X **d**ays * `reason` (optional) - a reason for the mute will be saved and printed # /unmute Description and use the command /unmute Bot's command `/unmute` is able moderators and administrators to unmute previously muted users. {% hint style="info" %} Note. This command supports arguments! Read the following paragraphs for the details. {% endhint %} {% hint style="success" %} Note. This command supports "quiet" mode. In this mode, your commands will be deleted, and members of your chat will not see any notifications\ To use "quiet" mode add "q" before the command (like /qunmute instead of /unmute) {% endhint %} ## Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ## Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} ### Simple usage Just send /unmute as a reply to any user's message and the user you reply to will be unmuted. ### Usage with arguments Command `/unmute` supports the following arguments: * Reason - the unmuted reason that will be saved #### Unmute user by a mention `/unmute ` Arguments for the `/unmute` command in this case are: * `mention` (required) - any valid user mention (just type @ and then mention any user muted in your chat by username or by name) * `reason` (optional) - a reason for the unmute will be saved and printed #### Unmute a user by reply You can also unmute a user by replying to their message with the unmute command `/unmute ` Arguments for the `/unmute` command in this case are: * `reason` (optional) - a reason for the unmute will be saved and printed # /muteinfo Description and use the command /muteinfo {% hint style="warning" %} Attention! Response on this command may contain sensitive data! Consider using the command in private chat with the bot. {% endhint %} ### Configuration of the command This command doesn't require additional configuration and is enabled for all chats. ### Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat {% endhint %} Command `/muteinfo` supports the following arguments: * username - the name of the user you want to get mute information to Example: `/muteinfo @username` # /warn & /rm\_warn Increase warn count for the user and reset warn count ## Command /warn Bot's command `/warn` able moderators and administrators to increase the warning level for a user, when warn count reaches the number you'd set up, the user will be banned. {% hint style="info" %} Note. This command supports arguments! Read the next paragraphs for the details {% endhint %} ### Configuration of the command * Press the button "Chat settings" near the selected chat on the ["My chats" page](https://fullyst.com/my_chats) * Open "Moderation" settings by clicking the corresponding menu item * Enable `/warn` command on the page * Set the number of warnings after which the user will be blocked

Moderation settings

### Command usage {% hint style="info" %} This command is available only for moderators and administrators in the chat. {% endhint %} #### Simple usage Just send `/warn` as a reply to a message and the author receive a warning.

How to warn user

In the answer, the bot will send a warning message with a current count of warnings

Answer from the bot (in this case user will be banned)

#### Usage with arguments Command `/warn` supports one argument * reason - the reason of warning

Increase warn level for the user and delete the message

## Command /rm\_warn Bot's command `/rm_warn` resets the warning level for the user. ### How to use {% hint style="info" %} This command has a link: /rm\_wans. Both commands do the same, so you may use any of these. {% endhint %} Just send `/rm_warn` or `/rm_warns` as a reply to the user's message

How to clear warn count for user

As a reply to the message user will receive a notification that the warnings have been removed

Notification for the user

# /warns\_list Description and use the command /warns\_list Command /warns\_list will show the list of warnings issued by the chat's administrator to a specific user. ### Command usage The command /warns\_list may be used in two ways: #### Reply to a message You can send the command /warns\_list as a reply to any messages from any user and the response for your reply will be the list of warnings for the user #### Usage with @mentrion Also, you can use the command /warns\_list with the mentioned username as an argument. For example: ``` /warns_list @username ``` As a reply to your command, you will get a list of warnings for user @username # /reload, /update Description and use the commands /reload and /update Bot commands /reload and /update will help you update your chat information in our system. Both commands work equally so that you can use any of them. {% hint style="info" %} Note. You should use this command in the chat you want to update information about {% endhint %} This command will help you in the following cases: 1. If you give administrator rights to @FullystBot in your chat but still get the following notification on our website

This notification means @FullystBot doesn't have asministrator rights in your chat

2. If you updated the name, link, or image of your chat but still have the old data on our website or in the bot responses Also, you can wait 15-45 minutes, and information will be updated automatically, but no need to wait - use /update or /reload command! # White-label API The white-label solution allows you to use all of Fullyst's features with your own bot. It increases the trust of your users and helps to get updates and responses to commands as quickly as possible {% hint style="info" %} Make sure that you have access to the API token of your Telegram bot before starting {% endhint %} ### Configure your bot in "full-control" mode In "full-control" mode we will automatically configure a webhook for your bot, so you can't use your own commands. But in this mode, you don't need to have your own servers and don't need to have programming skills. 1. Create an API application on the [API Settings](https://fullyst.com/api_settings) page 2. Insert the API token of your bot (received from @BotFather) in the form 3. Tick the "Full control" checkbox 4. Click the "Save" button

Configured White-label bot

Now you can use your bot as [@Fullystbot](/) ### Forwarding data to the webhook Unlike other services, we don't require full control over your bot and that's why we created it this way. This method is suitable for bots that must contain their own functionality different from Fullyst's functionality and require you to maintain your own webhook. 1. Create an API application on the [API Settings](https://fullyst.com/api_settings) page 2. Insert the API token of your bot (received from @BotFather) in the form 3. **Don't** tick the "Full control" checkbox 4. Click the "Save" button Now you should send all data that you receive from Telegram to our webhook API as a POST request: ``` https://api.fully.st/v1/webhook ``` with the following parameters: ``` key - API ID + API key combined with a colon, for example, eKgl2d2P:8afe4df7-df9e-5e79-8e28-4e83ae5530ce query - unchanged data received by your webhook from Telegram ``` {% hint style="info" %} **NB!** In the case that a substitution or change of messages on the side of your webhook is detected, we reserve the right to unilaterally suspend your API application and/or prohibit the creation and use of new API applications. {% endhint %} # Zero Trust moderation ### What is "Zero Trust moderation" “Zero Trust Moderation” is a modern and reliable solution designed to protect your chats from spam. It leverages the latest AI models along with internal triggers to detect and instantly remove spam messages and ban offending users. ### How it works “Zero Trust Moderation” continuously monitors messages from new users. If someone sends a message that the AI model classifies into one or more of the following categories, the message will be removed, and the sender will be banned within seconds. #### Tracking categories * Violence * Self-harm * Scams * Spam * Harassment * Hate speech These categories are currently fixed, but we plan to make them customizable in a future release. ### Limitations and known problems Due to the possibility of false positives, we recommend turning off “Zero Trust Moderation” for the following types of chats: * Buying and selling goods or services * Chats where one or more of the above topics are considered acceptable ### Why "Zero Trust moderation" 1. No manual setup required — works out of the box and is enabled by default for the eligible chats registered in Fullyst after 2024-04-07 2. Fast and reliable response to spam messages with the reason of the actions 3. Reduced spam by 96% in most chats 4. Safe-by-default approach # Captcha Captcha is not only about visual tests but for confirming is a user human or not. {% hint style="info" %} Are you just a member of a chat and not a chat administrator? Read the captcha description for chat members: {% endhint %} ### Captcha configuration For the current moment, you can configure a captcha with `/settings` command in DM with [@FullystBot](https://t.me/FullystBot) #### Button

Button captcha in action (the user joined the chat but ignored the first captcha)

This type of captcha is simple and easy to solve, but some spam bots can bypass this captcha. We recommend it to use this captcha type only with other spam-protection features like AI-antispam, NSFW protection, and moderation tools like [`/report`](/fullyst-bots-commands/report) command Math

Math captcha in action (the user joined the chat but ignored the first captcha)

This type of captcha provides an additional level of security and can protect your chat from 98% of spam bots. With math type, all new users must solve a simple math problem (for example 28+7, 3+18, 45-8) with five options with only one correct. The user has only a limited number of attempts and each incorrect choice will regenerate the math problem and solutions, so this type of captcha is almost impossible to bypass by spambots. After reaching the maximum number of attempts, the user will be banned and you can unban them only with the [`/unban`](/fullyst-bots-commands/unban) command or in chat's settings. # Captcha for chat members How Fullyst's captcha for Telegram chat works and how to pass it without hassle ### What is a "captcha" for Telegram and why? We in Fullyst use the "captcha" term features to check if the user is a human or a bot. So it's not only about the fuzzy text on the image but a bit more complex. Currently, [@FullystBot](https://t.me/FullystBot) has two types of captcha. #### Button It is the simplest method to solve and you can pass it in one second. All you need to do is click the button "I'm a human!" within 1 minute.

Button captcha in action

After clicking the bot message will disappear and you can start (or continue chatting). #### Math Math captcha requires some skills: you need to be able to solve a simple math problem like "23-8, 17+2, 5+13". You will have a limited number of attempts, so be careful, because if you reach the limit, you will be banned from the chat and only chat's administrators can unban you.

Math captcha in action

If you choose an incorrect solution, the math problem will be regenerated and you will see the new problem and new solutions, so you won't be able to go through all five options and bypass the check (but you can use a calculator if you want!) ### Q & A When all chats start using the captcha, will I have to go through it multiple times for each chat? > No, not really. If you confirm that you are human in one chat it will confirm you for all chats across @FullystBot, but ыome chats will be able to include a unique verification option, in such chats you will have to re-verify that you are a person. Why is the "captcha" needed? > Unfortunately, along with the growth of the Telegram Messenger, more and more spam bots appear, so chats administrators who want to keep chats clean from spam turned on the "captcha" function. I joined the chat but the captcha message from @FullystBot disappeared and I don't have enough time to confirm myself! What should I do? > Don't worry, just write any message to the chat and the captcha message will be send again. Unfortunately in this case your message will be removed, so you will need to send it again. # Hey, Fullyst! “Hey, Fullyst!” is an AI solution for you and your chats. ## How it works {% embed url="" fullWidth="false" %} How "Hey, Fullyst!" works {% endembed %} “Hey, Fullyst!” based on GPT models from OpenAI, for any paid users and chats, we used the latest (and more expensive) GPT-4, and for free chats, we used GPT-3.5, also a powerful model but not as GPT-4 (and cheaper). OpenAI has complicated billing based on “tokens,” which means you can’t count expenses without special tools, but we tried to make your usage of AI as simple as possible: * For the free plan, you can use 5 AI-answers per month for each of your chats and DMs with [@FullystBot](https://t.me/Fullystbot). * For the “[Pro](https://fullyst.com/pricing)” plan, your limit is 50 AI-answers per month (as mentioned above, it’ll be GPT-4). * For the “[Enterprise](https://fullyst.com/pricing)” plan, your limit will be 150 AI-answers per month with GPT-4. Maybe in this place, you would like to ask: What if I want more or unlimited AI answers? We have a solution: ask about it in our support chat, and we’ll contact you as soon as possible and discuss the details! ## Hey, Fullyst! Draw ... ## Limitations * Currently, Fullyst doesn’t support dialogs, which means that you may send your question and get the answer, but you can’t answer the bot message, and Fullyst can’t recognize requests like “please, give me more” because it doesn’t know any context. * Also, AI is just AI, so you can’t call bot commands and functions with AI requests. ## Our plans We will collect data on how users interact with our AI and then will improve it. Of course, the first thing will be to beat the limitations above :) And now, it’s time to use “Hey, Fullyst!” # NSFW filtering Sometimes NSFW content shoul be removed as quickly as possible. Our Telegram bot will help you to remove NSFW images! ## How it works At first, you should turn on NSFW filtering in the [chat settings](https://fullyst.com/my_chats) on the tab "Filters". And that's it. From the current moment, our AI will detect NSFW content in images and will remove it very fast (the average time to deletion is 180 milliseconds). ## Limitations As with any other AI model, our NSFW detector sometimes makes mistakes and may leave NSFW images in your chat or vice versa - it can remove something harmless. Unfortunately, we can't guarantee 100% accuracy, but our image recognition model has an accuracy of 99.23%, which is considered a good result.