The configuration for the Live Help chat clients are:
config.xml
It is located at <123LiveHelp5.1 installation directory>/html/config.xml
This file controls the basic configuration of the Admin Panel, Staff Panel and Customer Chat Client. You can modify the parameters referring to the table below:
(Among them, some are just for client.swf which only serves the end customers.)
Init Parameter/ Client APIs
This is used to make client.swf to get some initialization parameters by URL.
e.g.: http://localhost/client.swf?init_user=user&init_password=password
There are many initial parameters used in 123 Live Help 5.1 in order to integrate with 123livehelp swf files with web page more conveniently.
To generate code, please login 123livehelp admin panel-> general code, and follow the guide to accomplish. If you want to control the 123livehelp more precise, please refer to the following parameters.
1) init_host
Set 123livehlp server’s host name or IP, the default one is from current webpage URL. Eg. Your current webpage URL is http://yourhost.com/client.html , so the default hostname is yourhost.com, but you want to set the 123livehlp server’s hostname to otherhost.com, so please add this code to your generated code.
var init_host = 'otherhost.com';
After do that, when you click the livehelp button, the URL will be http://yourhost.com/client.html?init_host=otherhost.com;
2) init_port
Set 123livehlp server’s port, it always used together with init_host to connect server port and address.
Please add this code to your generated code
var init_port = 8969;
3) button_type
Set livehelp button type. In current version, there are three types, as follows:
BUTTON_TYPE_IMAGE Picture
BUTTON_TYPE_TEXT Text button
BUTTON_TYPE_NULL No button
You can refer to the following code:
var button_type = BUTTON_TYPE_IMAGE;
4) online_display and offline_display
Set the displayed picture or words in 123livehelp button. When the button type is BUTTON_TYPE_IMAGE, it displays picture, or the button type is BUTTON_TYPE_TEXT, words are displayed.
online_display : When sales is online, it displays the picture link or words.
offline_display: When sales is offline, it displays the picture link or words.
You can refer to the following code:
A. When displays picture
var button_type = BUTTON_TYPE_IMAGE;
var online_display = "http://yourhost.com/img/online.jpg";
var offline_display = "http://yourhost.com/img/offline.jpg";
B. When words are displayed
var button_type=BUTTON_TYPE_TEXT;
var online_display = "Operator is online. Click to chat.";
var offline_display = "Operator is offline. Click to leave a message.";
5) chat_window_skin
Set the popup window skin when click the button, now there are 5 kinds of skin: black ,blue,green,red and violet.
You can refer to the following code:
chat_window_skin = "violet";
6) chat_window_width和chat_window_height
Both of these parameters are set the popup window width and height. Currently, the minimum width is 495 pixels, and minimum height is 440 pixels. So when you set the value smaller than the minimum, it will be set to the minimum.
You can refer to the following code:
var chat_window_width = 495;
var chat_window_height = 440;
7) init_group
Set 123livehelp’s group name .It’s only valid for host customers and license users who bought pro version.
Every host user has a group name, and it’s applied by himself / herself.
License users who bought pro version, can possess several groups, and those groups don’t affect each other, it’s a pity this version isn’t sell now..
You can refer to the following code:
init_group ="default";
8) enable_invitation
This parameter defines webpage whether it allows the initiative to invite or not, if true, it means allow invitation, or false, it means not allow to invite.
You can refer to the following code:
var enable_invitation = true; // allow invitation
var enable_invitation = false;// not allow to invite
9) invitation_popup_type
This parameter defines the popup box type when sales send invitation, there are two types now.
INVITATION_STYLE_SLIDEDOWN：Invitation box slid slowly from the top of the screen to the middle
INVITATION_STYLE_POPUP：Invitation box appears suddenly to the middle of the screen
You can refer to the following code:
var invitation_popup_type = INVITATION_STYLE_POPUP;
10) invitation_skin
This parameter defines the popup box style, now there are 8 kinds, you can review them in admin panel, Generate Code->Invitation.
But it’s effective only when enable_invitation parameter is set to true.
You can refer to the following code:
var invitation_skin = INVITATION_STYLE_BROWN;
11) invitation_dept_id
This parameter defines the department to link to the chat invitation, and the value is department id, you can find the relevant id in admin panel ->Department.
Eg. You want sales to link to the chat invitation, and this department id is 1, so you can add this code to to your generated code:
var invitation_dept_id = 1;
12) button_assign_type
This parameter is set to the embedded code webpages, it can connect the customer's department or specific staff.
It has three values:
BUTTON_ASSIGN_NULL : All departments and staff can connect this customer
BUTTON_ASSIGN_STAFF: Only the specific staff can connect this customer, this parameter needs to use with pre_staff_id parameter.
BUTTON_ASSIGN_DEPT: Only the specific department can connect this customer, this parameter needs to use with pre_dept_id parameter.
13) pre_dept_id
This parameter needs to use together with button_assign_type parameter, you can refer to button_assign_type description for further study.
Only when button_assign_type is set to BUTTON_ASSIGN_DEPT, it could be use, and this value is the department id.
You can refer to the following code:
var button_assign_type = BUTTON_ASSIGN_DEPT;
var pre_dept_id="2";
14) pre_staff_id
This parameter needs to use together with button_assign_type parameter, you can refer to button_assign_type description for further study. Only when button_assign_type is set to BUTTON_ASSIGN_STAFF, it could be use, and this value is the sales username.
You can refer to the following code:
var button_assign_type = BUTTON_ASSIGN_STAFF;
var pre_staff_id = "operatora";
15) init_room
This parameter sets the embedded code webpage, when customer login, he/she will single sign-on the department, and it can used together with both init_user and init_password to finish the single sign-on function.
This value is the department id.
You can refer to the following code:
var init_room =1;
16) define_url
This parameter sets source files location, such as 123livehelp.swf, lib_123livehelp.swf and client.html.
If you can visit your livehelp address by http://livehelp.yourhost.com/client.html , then you can set:
define_url to var define_url = "http://livehelp.yourhost.com";
17) init_question
This parameter sets the question which you may face in 123livehelp webpage.
You can refer to the following code:
var init_question ="This is my question";
18)init_user
This parameter defines the default username in 123livehelp webpage. It’s always used in integration. For example, you have login the forum, the server won't connect to the user database directly, instead, it will send the username and password to the auth-url (it contains init_user). Then the auth-url requests the database to authenticate the user. Finally, the auth-url will return the feedback to the livehelp server in a predefined way, whether approved or declined, via this way the users needn’t to enter their username again.
If 123livehelp isn’t integrated with website, please set init_user and init_room parameters, then users can single sign-on.
Or123livehelp is integrated with website, need to set init_user , init_password and init_room parameters, if only set init_user parameter ,user will login as anonymity.
You can refer to the following code:
var init_user ="username";
19) init_password
This parameter is only valid when 123livehelp is integrated with the current website, and init_user parameter has set at the same time.
You can refer to the following code:
var init_user ="username";
var init_passwod ="mypasswod";
20) display_div_layerid
This parameter defines the position of the livehelp status button.
When you add livehelp status button code to the top of your webpage, sometimes when the livehelp and your website are not located on the same server, you may feel that livehelp will lag the webpage loading speed. The parameter is here to resolve the question. You can add the livehelp code at the bottom of the webpage (but before: </body>), and add this parameter in the code to control the position, so that livehelp will be loaded at last but positioned at top.
The default position for the 123livehelp status button is where the livehelp() function is embedded,
to change it, use display_div_layerid.
Firstly define a DIV with ID attribute, like: <div id ="livehelp_container" ></div>
Then put it to the desired place of your webpage.
Now add the following code before livehelp() function which generates code:
var display_div_layerid = "livehelp_container";
In which the 'livehelp_container' is the DIV ID defined above.
Livehelp api
Now you can find all development list, sales list, online development list and online operator list via live_status.js file, and live_status.js file is located in <123livehelp installation directory >/html/
The default path is http://yourhost:8988/live_status.js .
If you have modified the default path of live_status.js file, eg. you have copied the folder html to iis/ html, please set a new path in admin panel->Preferences->system settings->Live Status File Path.Otherwise 123livehelp can’t detect the sales status, whether he/she is online or not.
On the embedded live_status.js webpage, you can directly use JavaScript, via edit these arrays to obtain the relevant information.
deptList: This array is the list of all developments.
staffList: This array is the list of all sales
onlineStaff: This array is the list of online sales
onlineDept: This array is the list of online developments
