This is an overview of Support-Manager's commands and how they work.
How do commands work?
Commands usually follow a specific structure:
Every command starts with a prefix.
A prefix consists of one or more characters that signalize the bot that the following text
is a command that has to be evaluated.
Instead of using the regular prefix you can mention the bot.
- Right after the prefix (no space) goes the name of the command or command group. A command group contains multiple sub-commands that specify the exact action that the bot will perform.
- If the previous is a command group you can now specify the sub-command. Otherwise skip this.
- Finally most commands take one or more arguments. An argument is some information that you pass to the bot (e.g. a configuration value). If you want to pass more than one word into an argument you have to put it in quotes.
filter_1 Arguments signed with a little one are optional.
The examples below use the bot's default prefix.
However, since the prefix is customizable it might be different on your server.
This command gets you a list of all commands and how to use them. It does not explain what those commands do so just keep reading this website! 😉
- /help [command¹]
If you want to see a list of all commands, just type:
If want to know how e.g. the "/config" command works, type:
/configAliases: configure, set
Configure the bot on your server. Your options are:
|prefix||/set prefix !||Set a custom command prefix on your server.|
|notifications||/set notify #notifications||Set the notification channel (AKA "support channel").|
|role||/set role @Supporter||Set the support role.|
|scope||/set scope channel||Set the default ticket scope on your server ("private", "channel" or "local").|
|language||/set lang DE||Set the bot's language on your server. (the language must be supported)|
|category||/set category "support tickets"||Set the channel category in which ticket channels will be created. (for "channel"-scoped tickets)|
|voice||/set voice "voice support"||Set the channel category in which the bot will provide voice support channels.|
|log||/set log #log||Set the channel in which the bot logs some of it's actions.stars|
|assigning||/set assigning on||Enable/disable auto-assigning of tickets.stars|
For example, type:
/config notifications removeto remove the current notification channel, so you won't get notifications there anymore.
Guided configuration will show a dialog that helps you choosing the individual configurations. It will automatically appear when you don't specify any parameter.
This is the main command of the bot. It's used to perform various actions on a ticket.
|/ticket create [title] [description¹] [scope¹]||Create a new support ticket.|
|/ticket show [ticket ID]||Show a support ticket.|
|/ticket edit [ticket ID] [title¹] [description¹]||Edit a support ticket's title and/or description. Old content will be replaced.|
|/ticket append [ticket ID] [info]||Add additional information to a ticket's description.|
|/ticket respond [ticket ID] [content]||This is a shortcut for "/response create".|
|/ticket assign [ticket ID] [user]||Assign a ticket to a responsible user.stars|
|/ticket claim [ticket ID]||Assign a ticket to yourself.|
|/ticket close [ticket ID] [reason¹]||Close a support ticket when it's solved.|
|/ticket reopen [ticket ID]||Reopen a support ticket for resumed handling.|
|/ticket delete [ticket ID]||Delete a support ticket for good.|
For creating a ticket:
/ticket create "How does this bot work?" "I dunno how to use it."
The bot will generate a ticket and give it an ID e.g. #42
/ticket edit 42 "" "This is my new description."
This will only edit the description when you leave the title empty. But don't forget to leave empty quotes to tell the bot that you willingly want to skip the title. Otherwise it would only edit the title and not the description.
Responding to it:
/ticket respond 42 "Hey just type `/help` to see it's commands."
Perform actions on multiple tickets.
|/tickets [user¹]||Display either all tickets on the server or all tickets of a specific user.|
|/tickets close [ticket 1] [ticket 2] […]||Close multiple tickets using one command. Basically a shortcut for doing "/ticket close" multiple times.|
For closing 3 tickets at once:
/tickets close 11 42 1337
Perform actions on responses.
|/response create [ticket ID] [content]||Create a new response to a ticket.|
|/response show [response]||Show a specific response.|
|/response edit [response] [new content]||Edit a specific response. The old content will be replaced.|
|/response append [response] [additional content]||Add some additional info to a response.|
|/response delete [response]||Delete a response for good.|
For creating a response:
/response create 133 "This is my response."
The bot will generate a response and give it an ID e.g. #133-7.
/response edit 133-7 "This is my edited response."
Use this to outlaw user who act against the rules.
|/outlaw warn [user] [reason]||Warn an user.|
|/outlaw kick [user] [reason]||Kick an user.|
|/outlaw ban [user] [reason] [duration (days)¹]||Ban an user. Optionally specify a duration after that the user will be unbanned.|
Banning a user:
/outlaw ban @eviluser#1234 "This user is evil." 7
This will ban the user for a duration of 7 days. The bot will automatically unban the user when it is over.
For users to report other users for their misbehaviour.
- /report [user] [reason]
/report @eviluser#1234 "He spams in #general."
/statistics starsAlias: stats
Inspect server and user statistics.
|/stats||Inspect your server's statistics.stars|
|/stats [user]||Inspect a user's statistics.stars|
Server stats include e.g. information about how many tickets and responses have been created last 30 days or how many ticket and responses are being created per day on average.
User stats contain e.g. info about how often he was reported and how many tickets and responses he has created.
Manage your server's blacklist.
|/blacklist add [user] [reason] [duration (days)¹]||Add a user to your server's blacklist. Optionally add a duration.|
|/blacklist remove [user]||Remove a user from the blacklist.|
|/blacklist show||Display your server's blacklist.|
Users on this blacklist are not able to create tickets.
Get some info about the bot.
Invite the bot. It will lead you to the invitation page .