Skip to content

Command Reference

Simon Schürrle edited this page Aug 3, 2018 · 4 revisions

Master Commands

/admin

Description

The /admin Command allows a Master to add someone to the List of Staff that is allowed to use the Bot. Being Admin allows someone to use Admin commands and receive reports. If the Bot has permission to add Admins, they will automatically get Telegram Admin Permission in Groups that the Bot is in which allows them to Delete Messages or view Recent Actions.
Adding someone by Username will save them using their User ID since a Username can be changed so if an Admin changes his Username you don’t have to make them Admin again. Before being able to make someone Admin using the Username the bot has to “know” the User so all Admins should send the Bot a Private message or a message in a Group the bot manages. The Staff is excluded from getting automatic warns.

Syntax

In reply to a message: /admin
Using a Username: /admin @username
Using a User ID: /admin userid

/unadmin

Description

The /unadmin Command allows a Master to remove the User from the Staff list which will revoke them access to Admin commands.

Syntax

In reply to a message: /unadmin
Using a Username: /unadmin @username
Using a User ID: /unadmin userid

/leave

Description

The /leave Command allows a Master to make the bot leave a Group Cleanly. This Command removes the Group from the list of Groups, so this should always be used instead of Kicking the Bot.

Syntax

In a Group: /leave
Using the Group Name: /leave name
Using the Group ID: /leave groupid

/hidegroup

Description

The /hidegroup Command allows a Master to hide the Group the command was executed from the Bots /groups Command. The Command is useful if you add the Bot to your Admin group but don’t want people to Join.

Syntax

In a Group: /hidegroup

/showgroup

Description

The /showgroup Command allows a Master to show the Group the command was executed from the Bots /groups Command if it was hidden before.

Syntax

In a Group: /showgroup

Admin Commands

/warn

Description

The /warn Command allows an Admin or Master to warn a User. If used as a reply, the Bot will delete the Message that was replied to.

Syntax

In reply to a message: /warn reason
Using a Username: /warn @username reason
Using a User ID: /warn userid reason

/unwarn

Description

The /unwarn Command allows an Admin or Master to remove the last warn of a User. If the User was banned for having too many warns this will unban them.

Syntax

In reply to a message: /unwarn
Using a Username: /unwarn @username
Using a User ID: /unwarn userid

/nowarns

Description

The /nowarns Command allows an Admin or Master to remove all warns a User might have. If the User was banned for having too many warns this will unban them.

Syntax

In reply to a message: /nowarns
Using a Username: /nowarns @username
Using a User ID: /nowarns userid

/ban

Description

The /ban Command allows an Admin or Master to ban a User. If used as a reply, the Message that was replied to will be Deleted. Banning a User will remove him from all groups the Bot is administrating. If they aren’t in a Group but try to join after being banned, the bot will ban them after entering.

Syntax

In reply to a message: /ban reason
Using a Username: /ban @username reason
Using a User ID: /ban userid reason

/unban

Description

The /unban Command allows an Admin or Master to remove a User from the Banlist. The Command will unban the User in all Groups and will enable them to join again. This will remove all of the warns a User has.

Syntax

In reply to a message: /unban
Using a Username: /unban @username
Using a User ID: /unban userid

/user

Description

The /user Command allows an Admin or Master to view the Info of any User. This includes their Name, Status(member or Admin), User ID, Username and any warns they might have.
If the User is not an Admin, they can only view their info. If they use the command with a Username or User ID that is not theirs, the Bot will ignore the Command.
If a Username is used that is unknown to the bot, it will Display the Info for the Admin or Master that issued the Command instead.

Syntax

In reply to a message: /user
Using a Username: /user @username
Using a User ID: /user userid

/addcommand

Description

The /addcommand Command allows an Admin or Master to add a Custom Command that will be available in All Groups the Bot is managing.
Custom Commands are prefixed with an exclamation mark (!).
They can be limited to be either only used by Masters, Admins and Masters or Everyone. The restriction can be set in the First Part of the Custom Command Creation. They use the HTML Syntax for Markdown. If the Command already exists the Bot will ask if you want to replace it. Commands can be used in Groups or Private.

Example

A Command created with /addcommand test can be used by sending !test in a Group or Directly to the Bot.

Syntax

Direct Message to the Bot: /addcommand name\

/removecommand

Description

The /removecommand Command allows a Master to remove any Custom Command. Admins can only remove Commands for Admins or Everyone.

Syntax

Direct Message to the Bot: /removecommand name\

Everyone

/staff

Description

The /staff Command allows a User to Check the current List of Admins.

Syntax

In a Group or in Private: /staff\

/link

Description

The /link Command allows a User to get the Link for the Group the Command in which the command was issued.

Syntax

In a Group: /link\

/groups

Description

The /groups Command allows a User to get a list of groups the Bot manages. Groups hidden with /hidegroup will not show up.

Syntax

In a Group or in Private: /groups\

/report

Description

The /report Command allows a User to report a Message. The bot will send a Message that mentions all Admins in a Message.

Syntax

In reply to a message: /report\

/user

Description

The /user Command allows a User to get a List of their Current warns.

Syntax

In a Group or in Private: /user\

This has been converted from LaTeX to Markdown using pandoc. Original LaTeX File.