Chat API

Query string parameters available for use in Smart Invitation

Example:

<script type="text/javascript" src="https://www.mylivechat.com/chatapi.aspx?hccid=68268000
&SmartTemplate=2&SmartPhoto=3&SmartSoundFile=4"></script>
Parameter Description
hccid My LiveChat ID of your account. This ID is assigned to your account when it is originally created.
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, float randomly, topleft, topcenter, topright, middleleft, middlecenter, middleright, bottomleft, bottomcenter,bottomright
SmartOffsetX The relative position from the left edge of the viewable browser window.
Possible values: A number >=0
SmartOffsetY The relative position from the top edge of the viewable browser window.
Possible values: A number >=0
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.
SmartMessage Greeting message shows in 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, Offline
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 Possible values: A number >0 (Default: 2)
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 Possible values: A number >0 (Default: 2)
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 Possible values: A number >0 (Minutes, default: 10)
SmartUseShowTimeout Specifies the amount of time (in seconds) that the chat invitation is shown, starting from the first impression.
Possible values: 1, 0
SmartShowTimeout Possible values: A number >0 (Seconds, default: 30)
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 Possible values: A number >0 (Default: 5)
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 Possible values: A number >0 (Seconds, default: 30)
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 Possible values: A number >0 (Seconds, default: 120)
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
SmartVisitUrlFilter
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