Documentation

Support Board documentation

PLUGIN INSTALLATION AND USAGE

You can install the plugin in two ways:

  • Open the WordPress admin area and go to Plugins > Add New > Upload, select the file supportboard.zip and install the plugin, once installed activate it.
  • Unzip the content of supportboard.zip into the /wp-content/plugins/ directory and go to the plugins page of WordPress, activate the plugin.

Once the plugin is activated you need only to insert the following shortcodes:

|sb] or |sb type="chat"]

TICKETS

You can access to all your tickets from the menu item Support.
Users tab show all the registered users tickets, guests tab show only the not registered user chat conversations.
You can reply to a user ticket by click the reply button, when clicked the conversation is updated in real-time, every 10 seconds. This is important for the chat.
The tickets with a left green border are active and the user is waiting your reply, these tickets are always showed on top. The bottom tickets are partially hidden due not require a reply.

EDITOR

The Text Editor, both admin and front-end, support HTML codes and automatically convert the links.

USERS

From the settings tab you can choose from 2 users and membership systems, the indipendent users system provided by Support Board and disconnected from the WordPress users system or the original WordPress users system. If the user is not logged the login form is automatically showed, for WordPress users system will be showed the login page you setted on the settings tab or the original login url like www.site.com/wp-login.php. If you choose the WordPress users system all the registration and login parts must be provided by you.

AGENTS

You can add new agents from the Agents tab. Every agent can be assigned to a WordPress user so on admin login the correct agent will be automatically assigned, you can anyway change the agent that reply to a user ticket into the conversation.

API.AI

To integrate a bot powered by API.AI follow these steps:

  • Go to console.api.ai and register or login.
  • Click Create a new agent from the first item of the top left menu. You can load an existing ready to use bot by click Prebuilt agents menu
  • Click the gears icon on right of your agent name to get the access token.
  • The bot can send attachments with the string {files name|link name|link ...} where name is the name of the attachment and link is the url of the attachment, this string can be inserted into the message text of the bot. You may need to use the Web hooks (Fulfillment) to send dynamic attachments generated in real time.

SLACK

To integrate Slack with Support Board follow the instructions of the admin dashboard. Slack full integration require powerful servers and for this service fees are applied. You have 200 free messages for every Envato purchase code, when finished you can buy new credits by click the button below. Every Envato purchase code can be used for 1 domain only, if you change domain the previous one will not longer by sync with Slack. When your credits are near to finish Support Board will alert you directly on Slack.


EMAILS

You can activate email notifications that alert the user when an agent reply and alert the agents when a user reply. You can customize the email by go to Email tabs. You can use only text and the following patterns: {user_username}, {message}, {files}, {reply_link}, {site_name}, {site_url}. From the Settings tab you can test the email, if the email not work you can try to install the free plugin Mail SMTP By WPForms.


VARIOUS

ALLOWED FILE EXTENTIONS FOR UPLOAD
You can edit the allowed extensions from files wp-content/plugins/supportboard/include/upload.php and wp-content/plugins/supportboard/include/main.js, you must update both two files.


DEVELOPERS API

CodeReturned valueDescription
$_SESSION["sb-user-infos"]array("id" =>"", "img" =>"", "username" => "", "email" => "")Retrive the informations of the current logged-in user.
sb_get_settings()array("setting-name" =>"","setting-name" =>"", ...)Retrive all the settings of Support Board.
sb_register_user($id="", $img="", $username="", $psw="", $email="", $extra1="", $extra2="", $extra3="", $extra4="")"success" or a error messageRegister a new user.
sb_update_user($id="", $img="", $username="", $psw="", $email="", $extra1="", $extra2="", $extra3="", $extra4="")"success" or a error messageUpdate a existing user.
sb_ajax_logout()"success"Logout the user.
sb_is_logged_in()true or falseCheck if the user is logged-in.
sb_ajax_login(user, password)"success" or "error"Login the user with the given user and password.
sb_ajax_logout()"success"Logout the user.
sb_ajax_register(id, img, username, psw, email, extra1, extra2, extra3, extra4"success" or "error"Register a new user.
sb_ajax_update_user(id ,img, username, psw, email, extra1, extra2, extra3, extra4"success" or "error"Update an existing user.
sb_ajax_add_message(msg, files, time, user_id, user_img, user_name, user_type)"success" or "success-bot" or "error"Add a new message to the conversation of the current logged-in user.
sb_ajax_read_messages()JSON arrayGet the conversation of the current logged-in user.
$(".sb-chat-btn").click();--Open the chat.

The Javascript functions that require server side functions must be called via AJAX:

$.ajax({
method: "POST",
url: sb_ajax_url,
data: {
action: 'FUNCTION_NAME',
paramater: value,
paramater: value,
}
}).done(function (response) {
if (response == "success") { }
});

Replace FUNCTION_NAME with the function name of the table above and paramater: value with the parameters required by the function.