Chat API

Start Now for Free
Javascript API
Integration SettingsIntegration DemoSet Chat DataText Link DemoDepartment List DemoAgent List DemoSet User KeySet Product KeyNon-Javascript Link
Query String
CommonEmbedded ChatChat ButtonChat LinkChat BoxInvitationSmart InvitationWidgetNo Script
Query string parameters available for use in Invitation

Example:

<script type="text/javascript" src="https://www.mylivechat.com/chatapi.aspx?hccid=68268000
&InviteTemplate=6&InviteStartPos=middleleft&InviteAcceptTooltip=Start Chat"></script>
Parameter Description
hccid My LiveChat ID of your account. This ID is assigned to your account when it is originally created.
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
InvitePosition 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
InviteOffsetX The relative position from the left edge of the viewable browser window. This number must be >= 0.
Possible values: A number >=0
InviteOffsetY The relative position from the top edge of the viewable browser window. This number must be >= 0.
Possible values: A number >=0
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?
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.
Possible values: A number >=0 (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 >=0 (seconds)
InviteAcceptTooltip The ToolTip displays when visitors mouseover the Accept button.
InviteRejectTooltip The ToolTip displays when visitors mouseover the Close button.