Setting Parameters¶
Connection parameters largely define how Hotline works. Parameters are set in the setup bot after selecting the required connection (quick jump to the connection list is made with the /start command).
You can view frequent parameter sets necessary for your system usage scenario in the cases section.
Parameters Available in Setup Bot¶
WELCOME
Welcome message that user receives on first contact and when their request was closed (switched to /close status). Can be completely disabled on paid version. Free version requires Hotline link in welcome message.
Default value: standard welcome message in English.
AUTOCLOSE
Dialog auto-close period after last operator response, specified in hours.
If topic with user was closed, they'll receive welcome message from WELCOME parameter on next contact. Free version has maximum auto-close period of 48 hours.
Default value: 48 hours.
AUTO_INFO
Whether to automatically show available user information when topic is created.
Default value: don't show.
EXTENSIONS_ALLOWED
List of USER_ID users allowed to use important Hotline module functions (broadcast configuration and launch, tag configuration, client base export, etc.).
Default value: available only to connection administrator.
SILENT_MODE
Whether to show clients possible errors when processing their messages.
Default value: show errors.
IGNORE_CHATS
List of chats (USER_ID or CHAT_ID) whose messages should be ignored. Automatically includes banned chats.
Default value: 777000, SERVICE_USER_ID.
WHITE_LIST
List of chats (USER_ID or CHAT_ID) from which messages are accepted. All other chats are ignored.
Default value: NONE (all chats are accepted).
HIDE_INFO
Determines what client information is hidden from operators (names, group titles, user links, /info command output).
Default value: NONE (all information is available).
REPLY_ONLY
Activates a mode where outgoing messages can only be sent as an explicit reply (REPLY) to an incoming message.
Default value: FALSE (all messages are sent).
ICON_COLOR
Icon color for displaying connection topics in the backend group. Helps distinguish topics with multiple connections.
Default value: BLUE for bots, GREEN for accounts.
RESTRICTED_KEYWORDS_BACKEND
Array of prohibited keywords for outgoing messages. Triggers an error when attempting to send a message with specified words.
Default value: NONE (no filtering).
RESTRICTED_KEYWORDS_FRONTEND
Array of prohibited keywords for incoming messages. Messages with specified words are not forwarded to the backend group.
Default value: NONE (no filtering).
MONITOR_PRIVATE
Create and activate topics when receiving new private messages to the connected account or bot.
Default value: TRUE (private messages are processed).
MONITOR_GROUPS
Create and activate topics when new messages appear in group chats in which the connected account or bot is a member.
Default value: FALSE (groups are not monitored).
MONITOR_CHANNELS
Create and activate topics when new messages appear in channels to which the connected account is subscribed or in which the bot is a member.
Default value: FALSE (channels are not monitored).
PRIVATE_KEYWORDS
Array of keywords and phrases for filtering private messages. Activates only when keywords are detected in the user's message.
Default value: OFF (no filtering).
GROUPS_KEYWORDS
Array of keywords and phrases for filtering messages from group chats. Activates topics only when matching specified words.
Default value: OFF (no filtering).
CHANNELS_KEYWORDS
Array of keywords and phrases for filtering messages from channels. Activates topics only when matching specified phrases.
Default value: OFF (no filtering).
LEAVE_CLOSED
Determines the types of dialogs (private/group/channel) whose topics remain closed even when new incoming messages are received.
Default value: NONE (all topics are activated).
INTERCEPT_EXTERNAL
Disables duplication to the backend group of outgoing intercepted messages from parallel sessions of connected bots or accounts.
Default value: TRUE (messages are duplicated).
WEBHOOKS
One or more addresses for sending webhooks on system events or custom commands in JSON format.
Default value: NONE (webhooks are not sent).
CUSTOM_COMMANDS
List of custom commands for the custom bot in the backend group that will not trigger an error.
Default value: NONE (list is empty).
Additional Capabilities¶
In addition to the parameters available in the setup bot, Hotline has a number of additional configuration capabilities at the level of each specific connection, but they are only available through contacting the support service.