ZChat uses a number of special query string parameters which allows you pass custom variables so that you can change the chat behaviour dynamically. This document presents the query string parameters available for use in ZChat.
A query string parameter is a bit of code that you add to the end of your URL. Query string parameters are useful for passing data between web applications and use the familiar syntax:
http://<URL>?<Parameter>=<Value>
http://<URL>?<Parameter1>=<Value1>&<Parameter2>=<Value2>
| Parameter | Description |
|---|---|
| lang | The name of the query string parameter to use for setting the language.
Possible values:
|
Query string parameters available for use in Chat Button.
| Parameter | Description |
|---|---|
| ButtonVisible | Specifies whether to show chat button or not.
Possible values: 0 -- Hide, 1 -- Show |
| ButtonOnlineImage | The index of the currently selected item in the built-in image gallery.
Possible values: 1 to 16, upload |
| ButtonOfflineImage | The index of the currently selected item in the built-in image gallery.
Possible values: 1 to 16, upload |
| ButtonOnlineTooltip | The ToolTip displays when visitors mouseover the online image button. |
| ButtonOfflineTooltip | The ToolTip displays when visitors mouseover the offline image button. |
Query string parameters available for use in Chat Text Link.
| Parameter | Description |
|---|---|
| LinkVisible | Specifies whether to show chat link or not.
Possible values: 0 -- Hide, 1 -- Show |
| LinkOnlineCode | The Html Code displays when agents are online. |
| LinkOfflineCode | The Html Code displays when agents are offline. |
| LinkOnlineTooltip | The ToolTip displays when visitors mouseover the online link. |
| LinkOfflineTooltip | The ToolTip displays when visitors mouseover the offline link. |
Query string parameters available for use in Chat Box.
| Parameter | Description |
|---|---|
| BoxVisible | Specifies whether to show chat box or not.
Possible values: 0 -- Hide, 1 -- Show |
| BoxTemplate | The index of the currently selected item in the built-in chat box template.
Possible values: 1 to 4 |
| BoxOnlinePhoto | The index of the currently selected item in the built-in image gallery.
Possible values: 1 to 9, upload |
| BoxOfflinePhoto | The index of the currently selected item in the built-in image gallery.
Possible values: 1 to 9, upload |
| BoxOfflineCode | The text displays in the top area of chat box when agents are offline. |
| BoxOnlineTooltip | The ToolTip displays when visitors mouseover the online chat box. |
| BoxOfflineTooltip | The ToolTip displays when visitors mouseover the online chat box. |
| BoxMessage | The text displays in chat box text area. |
Query strings about no script code.
| Parameter | Description |
|---|---|
| LinkText | The Link Text. |
| LinkTitle | The ToolTip displays when the mouse moves over the link. |
Query string parameters available for use in Invitation.
| Parameter | Description |
|---|---|
| InviteTemplate | The index of the currently selected item in the built-in invitation template.
Possible values: 1 to 10 |
| InviteStartPos | The position where the Chat invitation will initially appear.
Possible values: auto,topleft,topcenter, topright,middleleft,middlecenter,middleright,bottomleft, bottomcenter,bottomright |
| InviteOffsetX | The relative position from the left edge of the viewable browser window. This
number must be >= 0. Possible values: a number |
| InviteOffsetY | The relative position from the top edge of the viewable browser window. This number
must be >= 0. Possible values: a number |
| InvitePhoto | The index of the currently selected item in the built-in image gallery.
Possible values: 1 to 10, upload |
| InviteHeadline | Header Message appears in the up-left corner of the invitation window. |
| InviteMessage | Greeting message shows in invitation window. Default: Hello, my name is (AGENT).
How can I help you today? (AGENT) is a variabl which will replaced with real agent's name. |
| InviteSoundFile | The index of the currently selected item in the built-in sound files. Possible values: 1 to 4 |
| InvitePlaySound | Specifies whether to play sound or not when inviting visitors. Possible values: 1, 0 |
| InviteShowTimeout | The number of seconds of an invitation is shown, starting from the first impression. This
number must be >= 0. Possible values: a number (seconds) |
| InviteHideTimeout | Specifies the minimum amount of time (in minutes) that must elapse since the visitor's
last chat or chat invitation before a new chat invitation would be shown. Possible values: a number (seconds) |
| InviteAcceptTooltip | The ToolTip displays when visitors mouseover the Accept button. |
| InviteRejectTooltip | The ToolTip displays when visitors mouseover the Close button. |
Query string parameters available for use in Smart Invitation.
| Parameter | Description |
|---|---|
| SmartVisible | Enable or disable smart invitation. Default: Disable
Possible values: 0 -- Hide, 1 -- Show |
| SmartCondition | Always prompt user or Only when agents online Possible values: always, online |
| SmartTemplate | The index of the currently selected item in the built-in smart invitation template. Possible values: 1 to 8 |
| SmartStartPos | The position where the Chat invitation will initially appear.
Possible values: auto,topleft,topcenter, topright,middleleft,middlecenter,middleright,bottomleft, bottomcenter,bottomright |
| SmartPosition | The position where the Chat invitation will float to and remain visiable to the
visitor.
Possible values: auto,topleft,topcenter, topright,middleleft,middlecenter,middleright,bottomleft, bottomcenter,bottomright |
| SmartOffsetX | The relative position from the left edge of the viewable browser window. This
number must be >= 0. Possible values: a number (seconds) |
| SmartOffsetY | The relative position from the top edge of the viewable browser window. Possible values: a number (seconds) |
| SmartPhoto | The index of the currently selected item in the built-in image gallery.
Possible values: 1 to 12, upload |
| SmartHeadline | Header Message appears in the up-left corner of the invitation window |
| SmartSoundFile | The index of the currently selected item in the built-in sound files.
Possible values: 1 to 4 |
| SmartPlaySound | Specifies whether to play sound or not when inviting visitors
Possible values: 1, 0 |
| SmartShowDepartments | Show all departments or which has online agent.
Possible values: All, Online |
| SmartClickOfflineItem | Open pre-chat window or offline window after click accept button when agents are
offline.
Possible values: PreChat, Online |
| SmartAcceptTooltip | The ToolTip displays when visitors mouseover the Accept button. |
| SmartRejectTooltip | The ToolTip displays when visitors mouseover the Close button. |
| SmartUseMaxReject | If enabled, a particular visitor to your web site will not get any more smart
invitations, after they have declined the specified number of previous chat invitations.
Possible values: 1, 0 |
| SmartMaxReject | Default value is 2. This
number must be >= 0. Possible values: a number |
| SmartUseMaxIgnore | If enabled, a particular visitor to your web site will not get any more smart
invitations, after they have ignored the specified number of previous chat invitations.
Possible values: 1, 0 |
| SmartMaxIgnore | Default value is 2. This
number must be >= 0. Possible values: a number |
| SmartUseHideTimeout | Specifies the minimum amount of time (in minutes) that must elapse since the visitor's
last chat or chat invitation before a new chat invitation would be shown. Possible values: 1, 0 |
| SmartHideTimeout | Default value is 10 minutes. This
number must be >= 0. Possible values: a number |
| SmartUseShowTimeout | Specifies the amount of time (in seconds) that the chat invitation is shown, starting
from the first impression.
Possible values: 1, 0 |
| SmartShowTimeout | Default value is 30 seconds. This
number must be >= 0. Possible values: a number |
| SmartHideIfChatting | Enable this option to prevent showing this chat invitation any further to a visitor
that has already had a chat session with you during this visit to your site.
Possible values: 1, 0 |
| SmartUsePageCount | Specifies the minimum number of page views that a visitor must have on this visit
in order to trigger the smart invitation.
Possible values: 1, 0 |
| SmartPageCount | Default value is 5. This
number must be >= 0. Possible values: a number |
| SmartUsePageTime | Specifies the minimum amount of time (in seconds) that a Web site visitor must
be on the current page in order to trigger the smart invitation.
Possible values: 1, 0 |
| SmartPageTime | Default value is 30 seconds. This
number must be >= 0. Possible values: a number |
| SmartUseStayTime | Specifies the minimum amount of time (in seconds) that a Web site visitor must
be on your web site in order to trigger the smart invitation.
Possible values: 1, 0 |
| SmartStayTime | Default value is 120 seconds. This
number must be >= 0. Possible values: a number |
| SmartUseVisitUrlFilter | Use this criterion to specify the text sub-string that must exist in the URL of
the current page view in order to trigger the smart invitation. It accepts a comma
separated string.
Possible values: 1, 0 |
| SmartUseEntryUrlFilter | Use this criterion to specify the text sub-string that must exist in the Entry
URL of the visit in order to trigger the smart invitation. It accepts a comma separated
string.
Possible values: 1, 0 |
| SmartEntryUrlFilter | |
| SmartUseReferUrlFilter | Use this criterion to specify the text sub-string that must exist in the Referral
URL in order to trigger the smart invitation. It accepts a comma separated string.
Possible values: 1, 0 |
| SmartReferUrlFilter | |
| SmartUseKeywordsFilter | Use this criterion to specify the Keyword(s) used by the visitor on the search
engine to reach this web site in order to trigger the smart invitation. It accepts
a comma separated string.
Possible values: 1, 0 |
| SmartKeywordsFilter |