Campaign

You need the Manage Campaigns permission to manage Campaign.

Campaigns
- Campaigns Manage
GET livechat/campaigns
GET livechat/campaigns/{id}
POST livechat/campaigns
PUT livechat/campaigns/{id}
DELETE livechat/campaigns/{id}
Chat Buttons
- Chat Buttons Manage
GET livechat/campaigns/{id}/chatButton
PUT livechat/campaigns/{id}/chatButton
Chat Button Gallery Images
- Chat Button Gallery Images Manage
GET livechat/chatButtonGalleryImages
GET livechat/chatButtonGalleryImages/{id}
Chat Windows
- Chat Windows Manage
GET livechat/campaigns/{id}/chatWindow
PUT livechat/campaigns/{id}/chatWindow
Chat Window Banner Gallery Images
- Chat Window Banner Gallery Images Manage
GET livechat/chatWindowBannerGalleryImages
GET livechat/chatWindowBannerGalleryImages/{id}
Chat Window Logo Gallery Images
- Chat Window Logo Gallery Images Manage
GET livechat/chatWindowLogoGalleryImages
GET livechat/chatWindowLogoGalleryImages/{id}
Pre-chat
- Pre-chat Manage
GET livechat/campaigns/{id}/preChat
POST livechat/campaigns/{id}/preChat:disable
POST livechat/campaigns/{id}/preChat:enable
PUT livechat/campaigns/{id}/preChat
Pre-chat Form Fields
- Pre-chat Form Fields Manage
GET livechat/preChatFormFields
GET livechat/preChatFormFields/{id}
Canned Messages
- Canned Messages Manage
GET livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig
POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:disable
POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:enable
PUT livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig
Offline Messages
- Offline Messages Manage
GET livechat/campaigns/{id}/offlineMessageConfig
PUT livechat/campaigns/{id}/offlineMessageConfig
Offline Message Form Fields
- Offline Message Form Fields Manage
GET livechat/offlineMessageFormFields
GET livechat/offlineMessageFormFields/{id}
Post-chats
- Post-chats Manage
GET livechat/campaigns/{id}/postChat
POST livechat/campaigns/{id}/postChat:disable
POST livechat/campaigns/{id}/postChat:enable
PUT livechat/campaigns/{id}/postChat
Post Chat Form Fields
- Post Chat Form Fields Manage
GET livechat/postChatFormFields
GET livechat/postChatFormFields/{id}
Rating Grades
- Rating Grades Manage
GET livechat/ratingGrades
GET livechat/ratingGrades/{id}
PUT livechat/ratingGrades/{id}
KB Integration
- KB Integration Manage
GET livechat/campaigns/{id}/integrationKbConfig
PUT livechat/campaigns/{id}/integrationKbConfig
Routing Rules
- Routing Rules Manage
GET livechat/campaigns/{id}/routingConfig
PUT livechat/campaigns/{id}/routingConfig
Rules
- Rules Manage
POST livechat/routingRules/{id}:disable
POST livechat/routingRules/{id}:enable
AI Chatbots
- AI Chatbots Manage
GET livechat/campaigns/{id}/integrationChatBotConfig
PUT livechat/campaigns/{id}/integrationChatBotConfig
Manual Invitations
- Manual Invitations Manage
GET livechat/campaigns/{id}/manualInvitation
PUT livechat/campaigns/{id}/manualInvitation
Languages
- Languages Manage
GET livechat/campaigns/{id}/languageConfig
GET livechat/campaigns/{id}/LanguageItems
PUT livechat/campaigns/{id}/languageConfig
Model
Campaign JSON Format

Campaign is represented as simple flat JSON objects with the following keys:

Name Type Description
name string Name of this campaign.
id guid Id of the campaign.
description string Description of this campaign.
language string Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek".

Routing Rule Condition JSON Format:

Name Type Description
id guid Id of the rule condition.
routingRuleId guid Id of the rule.
fieldName string Name of the field.
name operator
{!Visitor.Number of visits} is/isNot/isMoreThan/isLessThan
{!Visitor.Number of chats} is/isNot/isMoreThan/isLessThan
{!Visitor.Current Page URL} is/isNot/contains/notContains/regularExpression
{!Visitor.Referrer URL} is/isNot/contains/notContains/regularExpression
{!Visitor.Landing Page URL} is/isNot/contains/notContains/regularExpression
{!Visitor.Search Engine} is/isNot/contains/notContains/regularExpression
{!Visitor.Search Keywords} is/isNot/contains/notContains/regularExpression
{!Visitor.Country/Region} is/isNot/contains/notContains/regularExpression
{!Visitor.State/Province} is/isNot/contains/notContains/regularExpression
{!Visitor.City} is/isNot/contains/notContains/regularExpression
{!Visitor.Operating System} is/isNot/contains/notContains/regularExpression
{!Visitor.Time Zone} isOneOf/isNotIn
{!Visitor.Language} is/isNot/contains/notContains/regularExpression
{!Visitor.Segmentation} isOneOf/isNotIn
{!Chat.Request Page URL} is/isNot/contains/notContains/regularExpression
Other custom filters, allowed values are all fields of pre-chat, custom variable,salesforce e.g., {!Pre-Chat.Name}. Allowed values are "is", "contains", "notContains", "isMoreThan", "isLessThan", "isNot", "isNotLessThan", "isNotMoreThan", "regularExpression", "isOneOf", "isNotIn", e.g., contains.
operator string Allowed values are "is", "contains", "notContains", "isMoreThan", "isLessThan", "isNot", "isNotLessThan", "isNotMoreThan", "regularExpression", "isOneOf", "isNotIn", "dateNotEqualTo", "before", "after", "dateEqualTo".
value string Value of the condition.
order integer Order of the condition.
description string Description of the condition.

Custom Language JSON Format:

Name Type Description
campaignId guid Id of the campaign.
systemName string Name of the custom language.
customText string Custom test of the custom language.
id guid Id of the custom language.
Endpoint
Get the list of Campaigns

GET livechat/campaigns

Parameters:
Name Type In Required Description
keywords string query no Allowed values are "name","description"
include string query no Allowed values are "campaignChatButton", "campaignChatWindow", "campaignPreChat", "campaignPostChat", "campaignAutoInvitation", "campaignCannedMessageConfig", "campaignOfflineMessage", "wrapupFormField", "integrationKbConfig", "campaignRoutingConfig", "integrationChatBotConfig", "campaignManualInvitation", "campaignLanguageConfig".
Response:

An array of   Campaign

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}]
Get a single Campaign

GET livechat/campaigns/{id}

Parameters:
Name Type In Required Description
include string query no Allowed values are "campaignChatButton", "campaignChatWindow", "campaignPreChat", "campaignPostChat", "campaignAutoInvitation", "campaignCannedMessageConfig", "campaignOfflineMessage", "wrapupFormField", "integrationKbConfig", "campaignRoutingConfig", "integrationChatBotConfig", "campaignManualInvitation", "campaignLanguageConfig".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/E7B4BD07-C09D-4252-856E-49CA22537B94 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}
Create a new Campaign

POST livechat/campaigns

Parameters:
Name Type In Required Description
name string body yes Name of this campaign.
description string body no Description of this campaign.
language string body yes Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek".
chatButton chatButton body no Reference to Chat Button.
chatWindow chatWindow body no Reference to Chat Window.
preChat preChat body no Reference to Pre-chat.
autoInvitations autoInvitations[] body no Reference to Auto Invitation.
campaignLinkingToCannedMessageCategoriesConfig campaignLinkingToCannedMessageCategoriesConfig body no Reference to Canned Message.
offlineMessageConfig offlineMessageConfig body no Reference to Offline Message.
postChat postChat body no Reference to Post-chat.
wrapupFormFields wrapupFormFields[] body no Reference to Wrap-Up Field.
integrationKbConfig integrationKbConfig body no Reference to KB Integration.
routingConfig routingConfig body no Reference to Routing Rule.
integrationChatBotConfig integrationChatBotConfig body no Reference to AI Chatbot.
manualInvitation manualInvitation body no Reference to Manual Invitation.
languageConfig languageConfig body no Reference to Language.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Temporary Campaign","description":"This is a campaign for testing","language":"english","chatButton":{"type":"adaptive","isHiddenWhenOffline":false,"isDomainRestrictionEnabled":false,"allowedDomains":[],"adaptiveButtonColor":"#329FD9","isImageButtonFloating":true,"imageButtonPosition":"centered","imageButtonPositionMode":"","imageButtonXOffset":0,"isImageButtonXOffsetByPixel":false,"imageButtonYOffset":0,"isImageButtonYOffsetByPixel":false,"imageButtonImageSource":"fromGallery","builtinImageChatButtonImageId":"9DAE5329-7C46-EB11-8100-00155D081D0B","imageButtonOnlineImage":"https://autoapi.comm100dev.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOnlineImage?SiteId=10000&version=c5ee5b32b5fd67ce03027da05506f121","imageButtonOfflineImage":"https://autoapi.comm100dev.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOfflineImage?SiteId=10000&version=79095506f235b5ecd659431dcef80a00","imageButtonTypeOnMobile":"text","imageButtonColorOnMobile":"#222222","imageButtonTextColorOnMobile":"#ffffff","imageButtonOnlineImageOnMobile":"","imageButtonOfflineImageOnMobile":"","imageButtonPositionOnMobile":"bottomLeft","textLinkButtonText":"Chat Now","adaptiveButtonRightOffset":0,"adaptiveButtonBottomOffset":0,"adaptiveButtonRightOffsetOnMobile":0,"adaptiveButtonBottomOffsetOnMobile":0,"imageButtonOnlineTextOnMobile":"Chat with us","imageButtonOfflineTextOnMobile":"Leave a Message","customizedAdaptiveButtonImageSource":"fromGallery","customizedAdaptiveButtonImage":""},"chatWindow":{"style":"classic","color":"#329FD9","type":"embeddedChatWindow","classicStyleHeaderType":"agent","isAvatarDisplayed":true,"isTitleDisplayed":true,"isBioDisplayed":true,"isLogoDisplayed":true,"customLogoImage":"0x89504E470D0A1A0A0000000D49484452000003D40000015E080","customBannerImage":"0x1A0A0000000D49484452000003D40000015E080","isAvatarDisplayedWithMessage":true,"isBackgroundDisplayed":true,"backgroundTexture":"style1","customCSSOfClassic":".window--classic .window__headerBox {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n}\r\n.window--classic .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 54px);\r\n margin: 0 -27px -23px;\r\n}\r\n.window--classic .header__avatar {\r\n float: left;\r\n margin-right: 17px;\r\n width: 45px;\r\n height: 45px;\r\n -ms-flex-item-align: start;\r\n align-self: flex-start;\r\n}\r\n.window--classic .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 45px;\r\n height: 45px;\r\n}\r\n.window--classic .header__agent {\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n max-width: 100%;\r\n -webkit-box-flex: 0;\r\n -ms-flex-positive: 0;\r\n flex-grow: 0;\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n}\r\n.window--classic .header__agentName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--classic .header__agentTitle {\r\n font-size: 0.8rem;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n overflow: hidden;\r\n white-space: nowrap;\r\n text-overflow: ellipsis;\r\n}\r\n.window--classic .header__agentBio {\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n opacity: 0.8;\r\n margin-top: 4px;\r\n padding-left: 60px;\r\n padding-bottom: 2px;\r\n margin-bottom: -2px;\r\n max-height: 84px;\r\n overflow-y: auto;\r\n}\r\n.window--classic .header__logo {\r\n margin-left: auto;\r\n margin-top: 9px;\r\n margin-bottom: 5px;\r\n}\r\n.window--classic .header__logoImg {\r\n max-height: 45px;\r\n max-width: 100px;\r\n display: block;\r\n float: right;\r\n width: auto;\r\n height: auto;\r\n}\r\n.window--classic .header__teamName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-align: center;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n width: 100%;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n margin-bottom: 8px;\r\n}\r\n.window--classic .header__teamAvatar {\r\n position: relative;\r\n width: 142px;\r\n height: 40px;\r\n margin: 9px auto;\r\n}\r\n.window--classic .header__teamAvatarImg {\r\n position: absolute;\r\n width: 40px;\r\n height: 40px;\r\n border-radius: 100%;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(1) {\r\n left: 0;\r\n z-index: 9;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(2) {\r\n left: 49px;\r\n z-index: 8;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(3) {\r\n left: 99px;\r\n z-index: 7;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","customCSSOfCircle":".window--circle .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 40px);\r\n margin: 0 0 -15px -20px;\r\n}\r\n.window--circle .header__avatar {\r\n position: absolute;\r\n top: -69.5px;\r\n left: 50%;\r\n margin-left: -35px;\r\n}\r\n.window--circle .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 65px;\r\n height: 65px;\r\n margin: 0 auto;\r\n}\r\n.window--circle .header__agentName {\r\n max-width: calc(100% - 90px);\r\n margin: 0 auto;\r\n font-size: 1.13333333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--circle .header__agentTitle {\r\n font-size: 0.8rem;\r\n margin-top: 2px;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n}\r\n.window--circle .header__agentBio {\r\n text-align: center;\r\n margin-top: 2px;\r\n margin-bottom: 1px;\r\n padding-bottom: 2px;\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n display: -webkit-box;\r\n max-height: 70px;\r\n -webkit-line-clamp: 4;\r\n -webkit-box-orient: vertical;\r\n width: 100%;\r\n opacity: 0.8;\r\n overflow-y: auto;\r\n}\r\n.window--circle .header__teamName {\r\n font-size: 1.133333333333333rem;\r\n line-height: 1.29;\r\n margin-top: 21px;\r\n text-align: center;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n}\r\n.window--circle .header__teamAvatar {\r\n position: absolute;\r\n left: 50%;\r\n top: -22px;\r\n width: 112px;\r\n height: 42px;\r\n margin-bottom: 10px;\r\n margin-left: -56px;\r\n -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\r\n both;\r\n animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\r\n -webkit-animation-delay: 0.3s;\r\n animation-delay: 0.3s;\r\n}\r\n.window--circle .header__teamAvatarImg {\r\n position: absolute;\r\n width: 44px;\r\n height: 44px;\r\n border: 2px solid #fff;\r\n border-radius: 100%;\r\n top: 0;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(1) {\r\n z-index: 8;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(2) {\r\n left: 36px;\r\n z-index: 9;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(3) {\r\n right: 0;\r\n z-index: 10;\r\n}\r\n.window--circle .window__headerBox {\r\n border-bottom: 1px solid #ddd;\r\n width: calc(100% - 40px);\r\n margin: 0 auto;\r\n padding-left: 0;\r\n padding-right: 0;\r\n padding-bottom: 15px;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","isTranscriptDownloadAllowed":true,"isTranscriptSentToVisitors":true,"isTranscriptSentFromCurrentAgentEmail":true,"fromEmailName":"comm100User","fromEmailAddress":"comm100User@comm100.com","isSMTPServerCustomized":true,"customSMTPServerFromName":"user","customSMTPServerFromEmail":"user@thirdparty.com","customSMTPServerFromMailServer":"smtp.office365.com","customSMTPServerPort":25,"customSMTPServerEncryptedType":"ssl","isAuthenticationRequiredForCustomSMTPServer":false,"customSMTPServerUserName":"admin","customSMTPServerPassword":"password","ifAllowToSwitchToOfflineMessage":true,"ifAllowToSendFile":true,"ifMarkUnreadMessage":true,"isAudioChatEnabled":false,"isVideoChatEnabled":false,"isBrowserPopupNotificationEnabled":false,"ifEndChatWhenVisitorIsInactive":true,"minutesOfVisitorInactivity":"Mins15","isTranscriptSentForArchiving":false,"receivingEmailAddressesForArchivingTranscripts":["user@comm100.com"],"emailSubjectForArchivingTranscripts":"subject","greetingMessage":"<p>Hello, how can I help you?</p>","isCustomJSEnabled":true,"customJS":"Comm100API.on('livechat.chat.agent.join', function(agent) { console.log(agent) });\r\nComm100API.on('livechat.chat.agent.leave', function(agent) { console.log(agent) });","isTranscriptPrintAllowed":true,"isChatQueueMaxLengthEnabled":true,"chatQueueMaxLength":1,"chatQueueMaxWaitTime":60,"chatQueueLimitsMessage":"5","circleStyleHeaderType":"agent","popupChatWindowTitle":"Comm100 Live Chat - Chat Window","bannerImageSource":"fromGallery","logoImageSource":"fromGallery","builtinChatWindowLogoId":"3708e087-fe96-4f38-8874-d14024341fff","builtinChatWindowBannerImageId":"8dcab40f-2d1c-4c3d-a6b6-87b6ddad9d3e","ifRemovePoweredBy":true},"preChat":{"isEnabled":true,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"ifDisplayinRoutingRule":true,"ifDisplayinVisitorSSOMapping":true,"ifDisplayinSalesforceMapping":true,"ifDisplayinTicketMapping":true,"ifDisplayinCannedMessage":true}]},"autoInvitations":[{"name":"is","isEnabled":false,"isDisplayedOnceInOneSession":false,"order":1,"text":"Hello, how may I help you?","logicalExpression":"(1 or 2)","conditionMetType":"all","style":"bubble","autoInvitationConditions":[{"operator":"is","value":"test","order":1,"fieldName":"{!Visitor.Number of visits}"}]}],"campaignLinkingToCannedMessageCategoriesConfig":{"isEnabled":true},"offlineMessageConfig":{"type":"systemOfflineMessageWindow","customOfflineMessagePageURL":"https://www.google.com","ifOpenCustomOfflineMessagePageInNewWindow":true,"greetingMessage":"Please leave us a message and we will get back to you shortly.","emailOfflineMessageTo":"","customEmailAddresses":"carle3w@163.com.","isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"displayTeamName":"Our Team","formFieldLayoutStyle":"","popUpOfflineMessageTitle":"Comm100 Live Chat - Offline Message Window","isInputAreaEnabledWhenUsedInOfflineMessage":true,"taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","offlineMessageFormFields":[{"fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"ifDisplayinTicketMapping":true}]},"postChat":{"greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":true,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"ratingGrades":[{"grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]},"wrapupFormFields":[{"fieldId":"D8F2C475-490C-4427-9C3D-535DE30B45DE","label":"wrapup-text","isVisible":true,"isRequired":false,"order":0}],"integrationKbConfig":{"isEnabled":false,"selectedKbId":"6AAF5329-7C46-EB11-8100-00155D081D0B","isSearchAllowedBeforeChatting":true,"isSearchAllowedBeforeOfflineMessage":true,"articlesShowedInSearchResult":5,"greetingMessageBeforeChatting":"Search Knowledge Base","greetingMessageBeforeOfflineMessage":"Search Knowledge Base"},"routingConfig":{"isEnabled":false,"type":"simple","routeToTypeForSimpleRouting":"department","priorityForSimpleRouting":"normal","percentageToBot":0,"actionWhenNoRuleMatched":"routeToDepartmentorAgent","routeToTypeWhenNoRuleMatched":"department","priorityWhenNoRuleMatched":"normal","percentageToBotWhenNoRuleMatched":0,"emailsToReceiveOfflineMessage":["jason@comm100.com","alen@comm100.com"],"noRuleMatchedRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","noRuleMatchedRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","routingRules":[{"isEnabled":false,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}]}]},"integrationChatBotConfig":{"isEnabled":false,"selectedChatBotId":"15d08136-ee5c-44df-bdfd-f58877e3984b","isChatbotAllocatedWhenAgentOnline":false,"isChatbotAllocatedWhenAgentOffline":false,"distributeChatsToChatbotOption":"byQueueLength","queueLength":1,"percentageToChatbot":50,"isDistributeChatsWhenQueueLengthReachesEnabled":false},"manualInvitation":{"style":"bubble","invitationMessage":"Hello, how may I help you?"},"languageConfig":{"isCustomLanguageEnabled":false,"isTextDirectionRightToLeft":false,"customLanguageItems":[{"systemName":"LanguageButtonYes","customText":"Yes"}]}}'

Response:

 HTTP/1.1 201 Created

{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}
Update the Campaign

PUT livechat/campaigns/{id}

Parameters:
Name Type In Required Description
name string body yes Name of this campaign.
description string body no Description of this campaign.
language string body yes Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek".
chatButton chatButton body no Reference to Chat Button.
chatWindow chatWindow body no Reference to Chat Window.
preChat preChat body no Reference to Pre-chat.
autoInvitations autoInvitations[] body no Reference to Auto Invitation.
campaignLinkingToCannedMessageCategoriesConfig campaignLinkingToCannedMessageCategoriesConfig body no Reference to Canned Message.
offlineMessageConfig offlineMessageConfig body no Reference to Offline Message.
postChat postChat body no Reference to Post-chat.
wrapupFormFields wrapupFormFields[] body no Reference to Wrap-Up Field.
integrationKbConfig integrationKbConfig body no Reference to KB Integration.
routingConfig routingConfig body no Reference to Routing Rule.
integrationChatBotConfig integrationChatBotConfig body no Reference to AI Chatbot.
manualInvitation manualInvitation body no Reference to Manual Invitation.
languageConfig languageConfig body no Reference to Language.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/E7B4BD07-C09D-4252-856E-49CA22537B94 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Temporary Campaign","description":"This is a campaign for testing","language":"english","chatButton":{"type":"adaptive","isHiddenWhenOffline":false,"isDomainRestrictionEnabled":false,"allowedDomains":[],"adaptiveButtonColor":"#329FD9","isImageButtonFloating":true,"imageButtonPosition":"centered","imageButtonPositionMode":"","imageButtonXOffset":0,"isImageButtonXOffsetByPixel":false,"imageButtonYOffset":0,"isImageButtonYOffsetByPixel":false,"imageButtonImageSource":"fromGallery","builtinImageChatButtonImageId":"9DAE5329-7C46-EB11-8100-00155D081D0B","imageButtonOnlineImage":"https://autoapi.comm100dev.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOnlineImage?SiteId=10000&version=c5ee5b32b5fd67ce03027da05506f121","imageButtonOfflineImage":"https://autoapi.comm100dev.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOfflineImage?SiteId=10000&version=79095506f235b5ecd659431dcef80a00","imageButtonTypeOnMobile":"text","imageButtonColorOnMobile":"#222222","imageButtonTextColorOnMobile":"#ffffff","imageButtonOnlineImageOnMobile":"","imageButtonOfflineImageOnMobile":"","imageButtonPositionOnMobile":"bottomLeft","textLinkButtonText":"Chat Now","adaptiveButtonRightOffset":0,"adaptiveButtonBottomOffset":0,"adaptiveButtonRightOffsetOnMobile":0,"adaptiveButtonBottomOffsetOnMobile":0,"imageButtonOnlineTextOnMobile":"Chat with us","imageButtonOfflineTextOnMobile":"Leave a Message","customizedAdaptiveButtonImageSource":"fromGallery","customizedAdaptiveButtonImage":""},"chatWindow":{"style":"classic","color":"#329FD9","type":"embeddedChatWindow","classicStyleHeaderType":"agent","isAvatarDisplayed":true,"isTitleDisplayed":true,"isBioDisplayed":true,"isLogoDisplayed":true,"customLogoImage":"0x89504E470D0A1A0A0000000D49484452000003D40000015E080","customBannerImage":"0x1A0A0000000D49484452000003D40000015E080","isAvatarDisplayedWithMessage":true,"isBackgroundDisplayed":true,"backgroundTexture":"style1","customCSSOfClassic":".window--classic .window__headerBox {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n}\r\n.window--classic .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 54px);\r\n margin: 0 -27px -23px;\r\n}\r\n.window--classic .header__avatar {\r\n float: left;\r\n margin-right: 17px;\r\n width: 45px;\r\n height: 45px;\r\n -ms-flex-item-align: start;\r\n align-self: flex-start;\r\n}\r\n.window--classic .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 45px;\r\n height: 45px;\r\n}\r\n.window--classic .header__agent {\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n max-width: 100%;\r\n -webkit-box-flex: 0;\r\n -ms-flex-positive: 0;\r\n flex-grow: 0;\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n}\r\n.window--classic .header__agentName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--classic .header__agentTitle {\r\n font-size: 0.8rem;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n overflow: hidden;\r\n white-space: nowrap;\r\n text-overflow: ellipsis;\r\n}\r\n.window--classic .header__agentBio {\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n opacity: 0.8;\r\n margin-top: 4px;\r\n padding-left: 60px;\r\n padding-bottom: 2px;\r\n margin-bottom: -2px;\r\n max-height: 84px;\r\n overflow-y: auto;\r\n}\r\n.window--classic .header__logo {\r\n margin-left: auto;\r\n margin-top: 9px;\r\n margin-bottom: 5px;\r\n}\r\n.window--classic .header__logoImg {\r\n max-height: 45px;\r\n max-width: 100px;\r\n display: block;\r\n float: right;\r\n width: auto;\r\n height: auto;\r\n}\r\n.window--classic .header__teamName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-align: center;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n width: 100%;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n margin-bottom: 8px;\r\n}\r\n.window--classic .header__teamAvatar {\r\n position: relative;\r\n width: 142px;\r\n height: 40px;\r\n margin: 9px auto;\r\n}\r\n.window--classic .header__teamAvatarImg {\r\n position: absolute;\r\n width: 40px;\r\n height: 40px;\r\n border-radius: 100%;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(1) {\r\n left: 0;\r\n z-index: 9;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(2) {\r\n left: 49px;\r\n z-index: 8;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(3) {\r\n left: 99px;\r\n z-index: 7;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","customCSSOfCircle":".window--circle .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 40px);\r\n margin: 0 0 -15px -20px;\r\n}\r\n.window--circle .header__avatar {\r\n position: absolute;\r\n top: -69.5px;\r\n left: 50%;\r\n margin-left: -35px;\r\n}\r\n.window--circle .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 65px;\r\n height: 65px;\r\n margin: 0 auto;\r\n}\r\n.window--circle .header__agentName {\r\n max-width: calc(100% - 90px);\r\n margin: 0 auto;\r\n font-size: 1.13333333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--circle .header__agentTitle {\r\n font-size: 0.8rem;\r\n margin-top: 2px;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n}\r\n.window--circle .header__agentBio {\r\n text-align: center;\r\n margin-top: 2px;\r\n margin-bottom: 1px;\r\n padding-bottom: 2px;\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n display: -webkit-box;\r\n max-height: 70px;\r\n -webkit-line-clamp: 4;\r\n -webkit-box-orient: vertical;\r\n width: 100%;\r\n opacity: 0.8;\r\n overflow-y: auto;\r\n}\r\n.window--circle .header__teamName {\r\n font-size: 1.133333333333333rem;\r\n line-height: 1.29;\r\n margin-top: 21px;\r\n text-align: center;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n}\r\n.window--circle .header__teamAvatar {\r\n position: absolute;\r\n left: 50%;\r\n top: -22px;\r\n width: 112px;\r\n height: 42px;\r\n margin-bottom: 10px;\r\n margin-left: -56px;\r\n -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\r\n both;\r\n animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\r\n -webkit-animation-delay: 0.3s;\r\n animation-delay: 0.3s;\r\n}\r\n.window--circle .header__teamAvatarImg {\r\n position: absolute;\r\n width: 44px;\r\n height: 44px;\r\n border: 2px solid #fff;\r\n border-radius: 100%;\r\n top: 0;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(1) {\r\n z-index: 8;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(2) {\r\n left: 36px;\r\n z-index: 9;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(3) {\r\n right: 0;\r\n z-index: 10;\r\n}\r\n.window--circle .window__headerBox {\r\n border-bottom: 1px solid #ddd;\r\n width: calc(100% - 40px);\r\n margin: 0 auto;\r\n padding-left: 0;\r\n padding-right: 0;\r\n padding-bottom: 15px;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","isTranscriptDownloadAllowed":true,"isTranscriptSentToVisitors":true,"isTranscriptSentFromCurrentAgentEmail":true,"fromEmailName":"comm100User","fromEmailAddress":"comm100User@comm100.com","isSMTPServerCustomized":true,"customSMTPServerFromName":"user","customSMTPServerFromEmail":"user@thirdparty.com","customSMTPServerFromMailServer":"smtp.office365.com","customSMTPServerPort":25,"customSMTPServerEncryptedType":"ssl","isAuthenticationRequiredForCustomSMTPServer":false,"customSMTPServerUserName":"admin","customSMTPServerPassword":"password","ifAllowToSwitchToOfflineMessage":true,"ifAllowToSendFile":true,"ifMarkUnreadMessage":true,"isAudioChatEnabled":false,"isVideoChatEnabled":false,"isBrowserPopupNotificationEnabled":false,"ifEndChatWhenVisitorIsInactive":true,"minutesOfVisitorInactivity":"Mins15","isTranscriptSentForArchiving":false,"receivingEmailAddressesForArchivingTranscripts":["user@comm100.com"],"emailSubjectForArchivingTranscripts":"subject","greetingMessage":"<p>Hello, how can I help you?</p>","isCustomJSEnabled":true,"customJS":"Comm100API.on('livechat.chat.agent.join', function(agent) { console.log(agent) });\r\nComm100API.on('livechat.chat.agent.leave', function(agent) { console.log(agent) });","isTranscriptPrintAllowed":true,"isChatQueueMaxLengthEnabled":true,"chatQueueMaxLength":1,"chatQueueMaxWaitTime":60,"chatQueueLimitsMessage":"5","circleStyleHeaderType":"agent","popupChatWindowTitle":"Comm100 Live Chat - Chat Window","bannerImageSource":"fromGallery","logoImageSource":"fromGallery","builtinChatWindowLogoId":"3708e087-fe96-4f38-8874-d14024341fff","builtinChatWindowBannerImageId":"8dcab40f-2d1c-4c3d-a6b6-87b6ddad9d3e","ifRemovePoweredBy":true},"preChat":{"isEnabled":true,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"ifDisplayinRoutingRule":true,"ifDisplayinVisitorSSOMapping":true,"ifDisplayinSalesforceMapping":true,"ifDisplayinTicketMapping":true,"ifDisplayinCannedMessage":true}]},"autoInvitations":[{"name":"is","isEnabled":false,"isDisplayedOnceInOneSession":false,"order":1,"text":"Hello, how may I help you?","logicalExpression":"(1 or 2)","conditionMetType":"all","style":"bubble","autoInvitationConditions":[{"operator":"is","value":"test","order":1,"fieldName":"{!Visitor.Number of visits}"}]}],"campaignLinkingToCannedMessageCategoriesConfig":{"isEnabled":true},"offlineMessageConfig":{"type":"systemOfflineMessageWindow","customOfflineMessagePageURL":"https://www.google.com","ifOpenCustomOfflineMessagePageInNewWindow":true,"greetingMessage":"Please leave us a message and we will get back to you shortly.","emailOfflineMessageTo":"","customEmailAddresses":"carle3w@163.com.","isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"displayTeamName":"Our Team","formFieldLayoutStyle":"","popUpOfflineMessageTitle":"Comm100 Live Chat - Offline Message Window","isInputAreaEnabledWhenUsedInOfflineMessage":true,"taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","offlineMessageFormFields":[{"fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"ifDisplayinTicketMapping":true}]},"postChat":{"greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":true,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"ratingGrades":[{"grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]},"wrapupFormFields":[{"fieldId":"D8F2C475-490C-4427-9C3D-535DE30B45DE","label":"wrapup-text","isVisible":true,"isRequired":false,"order":0}],"integrationKbConfig":{"isEnabled":false,"selectedKbId":"6AAF5329-7C46-EB11-8100-00155D081D0B","isSearchAllowedBeforeChatting":true,"isSearchAllowedBeforeOfflineMessage":true,"articlesShowedInSearchResult":5,"greetingMessageBeforeChatting":"Search Knowledge Base","greetingMessageBeforeOfflineMessage":"Search Knowledge Base"},"routingConfig":{"isEnabled":false,"type":"simple","routeToTypeForSimpleRouting":"department","priorityForSimpleRouting":"normal","percentageToBot":0,"actionWhenNoRuleMatched":"routeToDepartmentorAgent","routeToTypeWhenNoRuleMatched":"department","priorityWhenNoRuleMatched":"normal","percentageToBotWhenNoRuleMatched":0,"emailsToReceiveOfflineMessage":["jason@comm100.com","alen@comm100.com"],"noRuleMatchedRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","noRuleMatchedRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","routingRules":[{"isEnabled":false,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}]}]},"integrationChatBotConfig":{"isEnabled":false,"selectedChatBotId":"15d08136-ee5c-44df-bdfd-f58877e3984b","isChatbotAllocatedWhenAgentOnline":false,"isChatbotAllocatedWhenAgentOffline":false,"distributeChatsToChatbotOption":"byQueueLength","queueLength":1,"percentageToChatbot":50,"isDistributeChatsWhenQueueLengthReachesEnabled":false},"manualInvitation":{"style":"bubble","invitationMessage":"Hello, how may I help you?"},"languageConfig":{"isCustomLanguageEnabled":false,"isTextDirectionRightToLeft":false,"customLanguageItems":[{"systemName":"LanguageButtonYes","customText":"Yes"}]}}'

Response:

 HTTP/1.1 200 OK

{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}
Remove the Campaign

DELETE livechat/campaigns/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/E7B4BD07-C09D-4252-856E-49CA22537B94 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

Model
Chat Button JSON Format

Chat Button is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
type string Allowed values are "adaptive", "image", "textLink".
isHiddenWhenOffline bool Whether the chat button is visible when no agent is online or not.
isDomainRestrictionEnabled bool Whether the domain restriction is enabled or not.
allowedDomains string [] An array of domains or urls, on which the chat button is visible.
adaptiveButtonColor string The theme color of the chat button. Available when type is adaptive.
isImageButtonFloating bool Whether the image button is float or not. Available when type is image.
imageButtonPosition string Allowed values are "centered", "topLeft", "topMiddle", "topRight", "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle".
imageButtonXOffset integer If isImageButtonXOffsetByPixel is true, it represents the offset pixel value of the X coordinate. If isImageButtonXOffsetByPixel is false, it represents the offset percentage value of the X coordinate. Available when type is image.
isImageButtonXOffsetByPixel bool Whether represents the offset pixel value of the X coordinate or not. Available when type is image.
imageButtonYOffset integer If isImageButtonYOffsetByPixel is true, it represents the offset pixel value of the Y coordinate. If isImageButtonYOffsetByPixel is false, it represents the offset percentage value of the Y coordinate. Available when type is image.
isImageButtonYOffsetByPixel bool Whether represents the offset pixel value of the Y coordinate or not. Available when type is image.
imageButtonImageSource string Allowed values are "fromGallery", "fromMyComputer".
builtinImageChatButtonImageId guid Id of the system chat button image.
imageButtonTypeOnMobile string Allowed values are "text", "image".
imageButtonColorOnMobile string Image button color on mobile device.
imageButtonTextColorOnMobile string The theme color of the chat button on mobile device.
imageButtonPositionOnMobile string Allowed values are "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle", "leftBottom", "rightBottom".
textLinkButtonText string The content of the text link. Available when type is textLink.
adaptiveButtonRightOffset integer Offset from right: XX pixels.
adaptiveButtonBottomOffset integer Offset from bottom: XX pixels.
adaptiveButtonRightOffsetOnMobile integer Offset from right on mobile device: XX pixels..
adaptiveButtonBottomOffsetOnMobile integer Offset from bottom on mobile device: XX pixels..
imageButtonOnlineTextOnMobile string The content of the online text link on mobile device, available when imageButtonTypeOnMobile is text.
imageButtonOfflineTextOnMobile string The content of the offline text link on mobile device, available when imageButtonTypeOnMobile is text.
customizedAdaptiveButtonImageSource string Allowed values are "fromGallery", "fromMyComputer".
imageButtonOnlineImage string Image file key of online button, available when type is image.
imageButtonOfflineImage string Image file key of offline button, available when type is image.
imageButtonOnlineImageOnMobile string The image file key on mobile device when any agents is online.
imageButtonOfflineImageOnMobile string The image file key on mobile device when no agents is online.
customizedAdaptiveButtonImage string The image file key of customized adaptive button image, available when type is adaptive.
builtinImageChatButtonImage builtinImageChatButtonImage Reference to Chat Button Gallery Image.
Endpoint
Get a single Chat Button

GET livechat/campaigns/{id}/chatButton

Parameters:
Name Type In Required Description
include string query no Allowed value is "chatButtonGalleryImage".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/8FAE5329-7C46-EB11-8100-00155D081D0B/chatButton \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"8FAE5329-7C46-EB11-8100-00155D081D0B","type":"adaptive","isHiddenWhenOffline":false,"isDomainRestrictionEnabled":false,"allowedDomains":[],"adaptiveButtonColor":"#329FD9","isImageButtonFloating":true,"imageButtonPosition":"centered","imageButtonXOffset":0,"isImageButtonXOffsetByPixel":false,"imageButtonYOffset":0,"isImageButtonYOffsetByPixel":false,"imageButtonImageSource":"fromGallery","builtinImageChatButtonImageId":"9DAE5329-7C46-EB11-8100-00155D081D0B","imageButtonOnlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImage","imageButtonOfflineImage":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOfflineImage","imageButtonTypeOnMobile":"text","imageButtonColorOnMobile":"#222222","imageButtonTextColorOnMobile":"#ffffff","imageButtonOnlineImageOnMobile":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImageOnMobile","imageButtonOfflineImageOnMobile":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOfflineImageOnMobile","imageButtonPositionOnMobile":"bottomLeft","textLinkButtonText":"Chat Now","adaptiveButtonRightOffset":0,"adaptiveButtonBottomOffset":0,"adaptiveButtonRightOffsetOnMobile":0,"adaptiveButtonBottomOffsetOnMobile":0,"imageButtonOnlineTextOnMobile":"Chat with us","imageButtonOfflineTextOnMobile":"Leave a Message","customizedAdaptiveButtonImageSource":"fromGallery","customizedAdaptiveButtonImage":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/customizedAdaptiveButtonImage","builtinImageChatButtonImage":{"id":"A56CFF58-C148-EB11-8100-00155D081D0B","themeColor":1,"onlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage","offlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/offlineImage","language":"turkish","order":1,"isVisible":true}}
Update the Chat Button

PUT livechat/campaigns/{id}/chatButton

Parameters:
Name Type In Required Description
type string body no Allowed values are "adaptive", "image", "textLink".
isHiddenWhenOffline bool body yes Whether the chat button is visible when no agent is online or not.
isDomainRestrictionEnabled bool body yes Whether the domain restriction is enabled or not.
allowedDomains string [] body yes An array of domains or urls, on which the chat button is visible.
adaptiveButtonColor string body no The theme color of the chat button. Available when type is adaptive.
isImageButtonFloating bool body yes Whether the image button is float or not. Available when type is image.
imageButtonPosition string body yes Allowed values are "centered", "topLeft", "topMiddle", "topRight", "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle".
imageButtonPositionMode string body no Allowed values are "basic", "advanced".
imageButtonXOffset integer body yes If isImageButtonXOffsetByPixel is true, it represents the offset pixel value of the X coordinate. If isImageButtonXOffsetByPixel is false, it represents the offset percentage value of the X coordinate. Available when type is image.
isImageButtonXOffsetByPixel bool body yes Whether represents the offset pixel value of the X coordinate or not. Available when type is image.
imageButtonYOffset integer body yes If isImageButtonYOffsetByPixel is true, it represents the offset pixel value of the Y coordinate. If isImageButtonYOffsetByPixel is false, it represents the offset percentage value of the Y coordinate. Available when type is image.
isImageButtonYOffsetByPixel bool body yes Whether represents the offset pixel value of the Y coordinate or not. Available when type is image.
imageButtonImageSource string body yes Allowed values are "fromGallery", "fromMyComputer".
builtinImageChatButtonImageId guid body yes Id of the system chat button image.
imageButtonTypeOnMobile string body yes Allowed values are "text", "image".
imageButtonColorOnMobile string body no Image button color on mobile device.
imageButtonTextColorOnMobile string body yes The theme color of the chat button on mobile device.
imageButtonPositionOnMobile string body yes Allowed values are "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle", "leftBottom", "rightBottom".
textLinkButtonText string body no The content of the text link. Available when type is textLink.
adaptiveButtonRightOffset integer body yes Offset from right: XX pixels.
adaptiveButtonBottomOffset integer body yes Offset from bottom: XX pixels.
adaptiveButtonRightOffsetOnMobile integer body yes Offset from right on mobile device: XX pixels..
adaptiveButtonBottomOffsetOnMobile integer body yes Offset from bottom on mobile device: XX pixels..
imageButtonOnlineTextOnMobile string body yes The content of the online text link on mobile device, available when imageButtonTypeOnMobile is text.
imageButtonOfflineTextOnMobile string body yes The content of the offline text link on mobile device, available when imageButtonTypeOnMobile is text.
customizedAdaptiveButtonImageSource string body no Allowed values are "fromGallery", "fromMyComputer".
imageButtonOnlineImage string body no Image file key of online button, available when type is image.
imageButtonOfflineImage string body no Image file key of offline button, available when type is image.
imageButtonOnlineImageOnMobile string body no The image file key on mobile device when any agents is online.
imageButtonOfflineImageOnMobile string body no The image file key on mobile device when no agents is online.
customizedAdaptiveButtonImage string body no The image file key of customized adaptive button image, available when type is adaptive.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/8FAE5329-7C46-EB11-8100-00155D081D0B/chatButton \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"type":"adaptive","isHiddenWhenOffline":false,"isDomainRestrictionEnabled":false,"allowedDomains":[],"adaptiveButtonColor":"#329FD9","isImageButtonFloating":true,"imageButtonPosition":"centered","imageButtonPositionMode":"","imageButtonXOffset":0,"isImageButtonXOffsetByPixel":false,"imageButtonYOffset":0,"isImageButtonYOffsetByPixel":false,"imageButtonImageSource":"fromGallery","builtinImageChatButtonImageId":"9DAE5329-7C46-EB11-8100-00155D081D0B","imageButtonOnlineImage":"https://autoapi.comm100dev.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOnlineImage?SiteId=10000&version=c5ee5b32b5fd67ce03027da05506f121","imageButtonOfflineImage":"https://autoapi.comm100dev.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOfflineImage?SiteId=10000&version=79095506f235b5ecd659431dcef80a00","imageButtonTypeOnMobile":"text","imageButtonColorOnMobile":"#222222","imageButtonTextColorOnMobile":"#ffffff","imageButtonOnlineImageOnMobile":"","imageButtonOfflineImageOnMobile":"","imageButtonPositionOnMobile":"bottomLeft","textLinkButtonText":"Chat Now","adaptiveButtonRightOffset":0,"adaptiveButtonBottomOffset":0,"adaptiveButtonRightOffsetOnMobile":0,"adaptiveButtonBottomOffsetOnMobile":0,"imageButtonOnlineTextOnMobile":"Chat with us","imageButtonOfflineTextOnMobile":"Leave a Message","customizedAdaptiveButtonImageSource":"fromGallery","customizedAdaptiveButtonImage":""}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"8FAE5329-7C46-EB11-8100-00155D081D0B","type":"adaptive","isHiddenWhenOffline":false,"isDomainRestrictionEnabled":false,"allowedDomains":[],"adaptiveButtonColor":"#329FD9","isImageButtonFloating":true,"imageButtonPosition":"centered","imageButtonXOffset":0,"isImageButtonXOffsetByPixel":false,"imageButtonYOffset":0,"isImageButtonYOffsetByPixel":false,"imageButtonImageSource":"fromGallery","builtinImageChatButtonImageId":"9DAE5329-7C46-EB11-8100-00155D081D0B","imageButtonOnlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImage","imageButtonOfflineImage":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOfflineImage","imageButtonTypeOnMobile":"text","imageButtonColorOnMobile":"#222222","imageButtonTextColorOnMobile":"#ffffff","imageButtonOnlineImageOnMobile":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImageOnMobile","imageButtonOfflineImageOnMobile":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOfflineImageOnMobile","imageButtonPositionOnMobile":"bottomLeft","textLinkButtonText":"Chat Now","adaptiveButtonRightOffset":0,"adaptiveButtonBottomOffset":0,"adaptiveButtonRightOffsetOnMobile":0,"adaptiveButtonBottomOffsetOnMobile":0,"imageButtonOnlineTextOnMobile":"Chat with us","imageButtonOfflineTextOnMobile":"Leave a Message","customizedAdaptiveButtonImageSource":"fromGallery","customizedAdaptiveButtonImage":"https://api15.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/customizedAdaptiveButtonImage","builtinImageChatButtonImage":{"id":"A56CFF58-C148-EB11-8100-00155D081D0B","themeColor":1,"onlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage","offlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/offlineImage","language":"turkish","order":1,"isVisible":true}}
Model
Chat Button Gallery Image JSON Format

Chat Button Gallery Image is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the chat button gallery image.
themeColor integer Allowed values are "0", "1", "2", "3", "4","5","6".
language string Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek".
order integer Order of the chat button gallery image.
isVisible bool Whether the chat button gallery image is visibled or not.
onlineImage string Image file key of online button, available when type is image.
offlineImage string Image file key of offline button, available when type is image.
Endpoint
Get the list of Chat Button Gallery Images

GET livechat/chatButtonGalleryImages

Parameters:
No Parameters
Response:

An array of   Chat Button Gallery Image

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/chatButtonGalleryImages \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"A56CFF58-C148-EB11-8100-00155D081D0B","themeColor":1,"onlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage","offlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/offlineImage","language":"turkish","order":1,"isVisible":true}]
Get a single Chat Button Gallery Image

GET livechat/chatButtonGalleryImages/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"A56CFF58-C148-EB11-8100-00155D081D0B","themeColor":1,"onlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage","offlineImage":"https://api15.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/offlineImage","language":"turkish","order":1,"isVisible":true}
Model
Chat Window JSON Format

Chat Window is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign which the chat window belongs to.
style string Allowed values are "classic", "circle", "bubble".
color string Color of the chat window.
type string Allowed values are "embeddedChatWindow", "popupChatWindow".
classicStyleHeaderType string Allowed values are "agent", "banner", "logo".
isAvatarDisplayed bool Whether the avatar of the agent is displayed or not, available when headerType is agentInfo or avatarAndLogo.
isTitleDisplayed bool Whether the title of the agent is displayed or not, available when headerType is agentInfo.
isBioDisplayed bool Whether the bio of the agent is displayed or not, available when headerType is agentInfo.
isLogoDisplayed bool Whether the logo is displayed or not, available when headerType is avatarAndLogo.
isAvatarDisplayedWithMessage bool Whether the avatar of the agent is display or not in the message body, available when style is classic or simple.
isBackgroundDisplayed bool Whether the texture and picture of the background is display or not in the message body, available when style is classic or simple.
backgroundTexture string Allowed values are "style1", "style2", "style3", "style4", "style5".
customCSSOfClassic string The custom CSS for classic stye.
customCSSOfCircle string The custom CSS for circle stye.
isTranscriptDownloadAllowed bool Whether the visitor can download the chat transcript.
isTranscriptSentToVisitors bool Whether visitors can request the chat transcripts or not.
isTranscriptSentFromCurrentAgentEmail bool Whether the transcript is sent by current agent email, available when isTranscriptDownloadAllowed is true.
fromEmailName string The from name for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true.
fromEmailAddress string The from email address for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true.
isSMTPServerCustomized bool Whether use custom SMTP server or not.
customSMTPServerFromName string The from name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerFromEmail string The from email address for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerFromMailServer string The mail server for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerPort integer The port for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerEncryptedType string Allowed values are "none", "ssl", "tls".
isAuthenticationRequiredForCustomSMTPServer bool Whether the authentication is required or not for custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerUserName string The user name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerPassword string The password for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
ifAllowToSwitchToOfflineMessage bool Whether visitors are allowed to switch to offlice message whindow while waiting for chat.
ifAllowToSendFile bool Whether the agent can send file or not.
ifMarkUnreadMessage bool Whether the unread message is marked or not.
isAudioChatEnabled bool Whether this audio chat is enabled or not.
isVideoChatEnabled bool Whether this video chat is enabled or not.
isBrowserPopupNotificationEnabled bool Whether this browser popup notification is enabled or not, it is available for private server sites. For shared server clients, the push notificatiton is disabled by default.
ifEndChatWhenVisitorIsInactive bool Whether the chat ends or not if visitor don't respond in period of time.
minutesOfVisitorInactivity string Allowed values are "Mins3", "Mins5", "Mins10", "Mins15", "Mins20", "Mins30", "1Hour".
isTranscriptSentForArchiving bool Whether the transcript is sent for archiving or not.
receivingEmailAddressesForArchivingTranscripts string [] The email address to receive the transcript that is sent for archiving.
emailSubjectForArchivingTranscripts string The email subject of the transcript that is sent for archiving.
greetingMessage string Greeting message of the chat window.
isCustomJSEnabled bool Whether this custom JS is enabled or not.
customJS string Custom JS of the chat window.
isTranscriptPrintAllowed bool Whether the visitor can print the chat transcript or not.
isChatQueueMaxLengthEnabled bool Whether this chat queue max length is enabled or not.
chatQueueMaxLength integer The max length of current chat queue.
chatQueueMaxWaitTime integer The max wait time of current chat queue.
chatQueueLimitsMessage string The message limits of current chat queue.
circleStyleHeaderType string Allowed values are "agent", "banner".
popupChatWindowTitle string The title of this chat window. Available when type is popupChatWindow.
bannerImageSource string Allowed values are "fromGallery", "fromMyComputer".
logoImageSource string Allowed values are "fromGallery", "fromMyComputer".
builtinChatWindowLogoId guid Id of the default chat window logo.
builtinChatWindowBannerImageId guid Id of the default chat window banner image .
ifRemovePoweredBy bool Content of the custom page.
customLogoImage string Image file key of logo, available when header type is logo.
customBannerImage string Image file key of banner, available when header type is banner.
builtinChatWindowBannerImage builtinChatWindowBannerImage Reference to Chat Window Banner Gallery Image.
builtinChatWindowLogo builtinChatWindowLogo Reference to Chat Window Logo Gallery Image.
Endpoint
Get a single Chat Window

GET livechat/campaigns/{id}/chatWindow

Parameters:
Name Type In Required Description
include string query no Allowed values are "chatWindowBannerGalleryImage", "chatWindowLogoGalleryImage".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/27792c81-38d2-4398-ba40-bafc804ffd2d/chatWindow \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"27792c81-38d2-4398-ba40-bafc804ffd2d","style":"classic","color":"#329FD9","type":"embeddedChatWindow","classicStyleHeaderType":"agent","isAvatarDisplayed":true,"isTitleDisplayed":true,"isBioDisplayed":true,"isLogoDisplayed":true,"customLogoImage":"https://api15.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customLogoImage","customBannerImage":"https://api15.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customBannerImage","isAvatarDisplayedWithMessage":true,"isBackgroundDisplayed":true,"backgroundTexture":"style1","customCSSOfClassic":".window--classic .window__headerBox {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n}\r\n.window--classic .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 54px);\r\n margin: 0 -27px -23px;\r\n}\r\n.window--classic .header__avatar {\r\n float: left;\r\n margin-right: 17px;\r\n width: 45px;\r\n height: 45px;\r\n -ms-flex-item-align: start;\r\n align-self: flex-start;\r\n}\r\n.window--classic .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 45px;\r\n height: 45px;\r\n}\r\n.window--classic .header__agent {\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n max-width: 100%;\r\n -webkit-box-flex: 0;\r\n -ms-flex-positive: 0;\r\n flex-grow: 0;\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n}\r\n.window--classic .header__agentName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--classic .header__agentTitle {\r\n font-size: 0.8rem;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n overflow: hidden;\r\n white-space: nowrap;\r\n text-overflow: ellipsis;\r\n}\r\n.window--classic .header__agentBio {\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n opacity: 0.8;\r\n margin-top: 4px;\r\n padding-left: 60px;\r\n padding-bottom: 2px;\r\n margin-bottom: -2px;\r\n max-height: 84px;\r\n overflow-y: auto;\r\n}\r\n.window--classic .header__logo {\r\n margin-left: auto;\r\n margin-top: 9px;\r\n margin-bottom: 5px;\r\n}\r\n.window--classic .header__logoImg {\r\n max-height: 45px;\r\n max-width: 100px;\r\n display: block;\r\n float: right;\r\n width: auto;\r\n height: auto;\r\n}\r\n.window--classic .header__teamName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-align: center;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n width: 100%;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n margin-bottom: 8px;\r\n}\r\n.window--classic .header__teamAvatar {\r\n position: relative;\r\n width: 142px;\r\n height: 40px;\r\n margin: 9px auto;\r\n}\r\n.window--classic .header__teamAvatarImg {\r\n position: absolute;\r\n width: 40px;\r\n height: 40px;\r\n border-radius: 100%;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(1) {\r\n left: 0;\r\n z-index: 9;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(2) {\r\n left: 49px;\r\n z-index: 8;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(3) {\r\n left: 99px;\r\n z-index: 7;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","customCSSOfCircle":".window--circle .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 40px);\r\n margin: 0 0 -15px -20px;\r\n}\r\n.window--circle .header__avatar {\r\n position: absolute;\r\n top: -69.5px;\r\n left: 50%;\r\n margin-left: -35px;\r\n}\r\n.window--circle .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 65px;\r\n height: 65px;\r\n margin: 0 auto;\r\n}\r\n.window--circle .header__agentName {\r\n max-width: calc(100% - 90px);\r\n margin: 0 auto;\r\n font-size: 1.13333333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--circle .header__agentTitle {\r\n font-size: 0.8rem;\r\n margin-top: 2px;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n}\r\n.window--circle .header__agentBio {\r\n text-align: center;\r\n margin-top: 2px;\r\n margin-bottom: 1px;\r\n padding-bottom: 2px;\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n display: -webkit-box;\r\n max-height: 70px;\r\n -webkit-line-clamp: 4;\r\n -webkit-box-orient: vertical;\r\n width: 100%;\r\n opacity: 0.8;\r\n overflow-y: auto;\r\n}\r\n.window--circle .header__teamName {\r\n font-size: 1.133333333333333rem;\r\n line-height: 1.29;\r\n margin-top: 21px;\r\n text-align: center;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n}\r\n.window--circle .header__teamAvatar {\r\n position: absolute;\r\n left: 50%;\r\n top: -22px;\r\n width: 112px;\r\n height: 42px;\r\n margin-bottom: 10px;\r\n margin-left: -56px;\r\n -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\r\n both;\r\n animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\r\n -webkit-animation-delay: 0.3s;\r\n animation-delay: 0.3s;\r\n}\r\n.window--circle .header__teamAvatarImg {\r\n position: absolute;\r\n width: 44px;\r\n height: 44px;\r\n border: 2px solid #fff;\r\n border-radius: 100%;\r\n top: 0;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(1) {\r\n z-index: 8;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(2) {\r\n left: 36px;\r\n z-index: 9;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(3) {\r\n right: 0;\r\n z-index: 10;\r\n}\r\n.window--circle .window__headerBox {\r\n border-bottom: 1px solid #ddd;\r\n width: calc(100% - 40px);\r\n margin: 0 auto;\r\n padding-left: 0;\r\n padding-right: 0;\r\n padding-bottom: 15px;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","isTranscriptDownloadAllowed":true,"isTranscriptSentToVisitors":true,"isTranscriptSentFromCurrentAgentEmail":true,"fromEmailName":"comm100User","fromEmailAddress":"comm100User@comm100.com","isSMTPServerCustomized":true,"customSMTPServerFromName":"user","customSMTPServerFromEmail":"user@thirdparty.com","customSMTPServerFromMailServer":"smtp.office365.com","customSMTPServerPort":25,"customSMTPServerEncryptedType":"ssl","isAuthenticationRequiredForCustomSMTPServer":false,"customSMTPServerUserName":"admin","customSMTPServerPassword":"password","ifAllowToSwitchToOfflineMessage":true,"ifAllowToSendFile":true,"ifMarkUnreadMessage":true,"isAudioChatEnabled":false,"isVideoChatEnabled":false,"isBrowserPopupNotificationEnabled":false,"ifEndChatWhenVisitorIsInactive":true,"minutesOfVisitorInactivity":"Mins15","isTranscriptSentForArchiving":false,"receivingEmailAddressesForArchivingTranscripts":["user@comm100.com"],"emailSubjectForArchivingTranscripts":"subject","greetingMessage":"<p>Hello, how can I help you?</p>","isCustomJSEnabled":true,"customJS":"Comm100API.on('livechat.chat.agent.join', function(agent) { console.log(agent) });\r\nComm100API.on('livechat.chat.agent.leave', function(agent) { console.log(agent) });","isTranscriptPrintAllowed":true,"isChatQueueMaxLengthEnabled":true,"chatQueueMaxLength":1,"chatQueueMaxWaitTime":60,"chatQueueLimitsMessage":"5","circleStyleHeaderType":"agent","popupChatWindowTitle":"Comm100 Live Chat - Chat Window","bannerImageSource":"fromGallery","logoImageSource":"fromGallery","builtinChatWindowLogoId":"3708e087-fe96-4f38-8874-d14024341fff","builtinChatWindowBannerImageId":"8dcab40f-2d1c-4c3d-a6b6-87b6ddad9d3e","ifRemovePoweredBy":true,"builtinChatWindowBannerImage":{"id":"AB6CFF58-C148-EB11-8100-00155D081D0B","bannerImage":"https://api15.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage","order":1,"isVisible":true},"builtinChatWindowLogo":{"id":"B86CFF58-C148-EB11-8100-00155D081D0B","logoImage":"https://api15.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage","order":1}}
Update the Chat Window

PUT livechat/campaigns/{id}/chatWindow

Parameters:
Name Type In Required Description
style string body no Allowed values are "classic", "circle", "bubble".
color string body no Color of the chat window.
type string body no Allowed values are "embeddedChatWindow", "popupChatWindow".
classicStyleHeaderType string body no Allowed values are "agent", "banner", "logo".
isAvatarDisplayed bool body yes Whether the avatar of the agent is displayed or not, available when headerType is agentInfo or avatarAndLogo.
isTitleDisplayed bool body yes Whether the title of the agent is displayed or not, available when headerType is agentInfo.
isBioDisplayed bool body yes Whether the bio of the agent is displayed or not, available when headerType is agentInfo.
isLogoDisplayed bool body yes Whether the logo is displayed or not, available when headerType is avatarAndLogo.
isAvatarDisplayedWithMessage bool body yes Whether the avatar of the agent is display or not in the message body, available when style is classic or simple.
isBackgroundDisplayed bool body yes Whether the texture and picture of the background is display or not in the message body, available when style is classic or simple.
backgroundTexture string body yes Allowed values are "style1", "style2", "style3", "style4", "style5".
customCSSOfClassic string body no The custom CSS for classic stye.
customCSSOfCircle string body no The custom CSS for circle stye.
isTranscriptDownloadAllowed bool body yes Whether the visitor can download the chat transcript.
isTranscriptSentToVisitors bool body yes Whether visitors can request the chat transcripts or not.
isTranscriptSentFromCurrentAgentEmail bool body yes Whether the transcript is sent by current agent email, available when isTranscriptDownloadAllowed is true.
fromEmailName string body yes The from name for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true.
fromEmailAddress string body yes The from email address for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true.
isSMTPServerCustomized bool body yes Whether use custom SMTP server or not.
customSMTPServerFromName string body yes The from name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerFromEmail string body yes The from email address for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerFromMailServer string body yes The mail server for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerPort integer body no The port for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerEncryptedType string body yes Allowed values are "none", "ssl", "tls".
isAuthenticationRequiredForCustomSMTPServer bool body yes Whether the authentication is required or not for custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerUserName string body no The user name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
customSMTPServerPassword string body no The password for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true.
ifAllowToSwitchToOfflineMessage bool body yes Whether visitors are allowed to switch to offlice message whindow while waiting for chat.
ifAllowToSendFile bool body yes Whether the agent can send file or not.
ifMarkUnreadMessage bool body yes Whether the unread message is marked or not.
isAudioChatEnabled bool body yes Whether this audio chat is enabled or not.
isVideoChatEnabled bool body yes Whether this video chat is enabled or not.
isBrowserPopupNotificationEnabled bool body yes Whether this browser popup notification is enabled or not, it is available for private server sites. For shared server clients, the push notificatiton is disabled by default.
ifEndChatWhenVisitorIsInactive bool body yes Whether the chat ends or not if visitor don't respond in period of time.
minutesOfVisitorInactivity string body yes Allowed values are "Mins3", "Mins5", "Mins10", "Mins15", "Mins20", "Mins30", "1Hour".
isTranscriptSentForArchiving bool body yes Whether the transcript is sent for archiving or not.
receivingEmailAddressesForArchivingTranscripts string [] body yes The email address to receive the transcript that is sent for archiving.
emailSubjectForArchivingTranscripts string body yes The email subject of the transcript that is sent for archiving.
greetingMessage string body no Greeting message of the chat window.
isCustomJSEnabled bool body yes Whether this custom JS is enabled or not.
customJS string body no Custom JS of the chat window.
isTranscriptPrintAllowed bool body yes Whether the visitor can print the chat transcript or not.
isChatQueueMaxLengthEnabled bool body yes Whether this chat queue max length is enabled or not.
chatQueueMaxLength integer body yes The max length of current chat queue.
chatQueueMaxWaitTime integer body yes The max wait time of current chat queue.
chatQueueLimitsMessage string body no The message limits of current chat queue.
circleStyleHeaderType string body no Allowed values are "agent", "banner".
popupChatWindowTitle string body yes The title of this chat window. Available when type is popupChatWindow.
bannerImageSource string body no Allowed values are "fromGallery", "fromMyComputer".
logoImageSource string body no Allowed values are "fromGallery", "fromMyComputer".
builtinChatWindowLogoId guid body yes Id of the default chat window logo.
builtinChatWindowBannerImageId guid body yes Id of the default chat window banner image .
ifRemovePoweredBy bool body no Content of the custom page.
customLogoImage string body no Image file key of logo, available when header type is logo.
customBannerImage string body no Image file key of banner, available when header type is banner.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/27792c81-38d2-4398-ba40-bafc804ffd2d/chatWindow \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"style":"classic","color":"#329FD9","type":"embeddedChatWindow","classicStyleHeaderType":"agent","isAvatarDisplayed":true,"isTitleDisplayed":true,"isBioDisplayed":true,"isLogoDisplayed":true,"customLogoImage":"0x89504E470D0A1A0A0000000D49484452000003D40000015E080","customBannerImage":"0x1A0A0000000D49484452000003D40000015E080","isAvatarDisplayedWithMessage":true,"isBackgroundDisplayed":true,"backgroundTexture":"style1","customCSSOfClassic":".window--classic .window__headerBox {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n}\r\n.window--classic .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 54px);\r\n margin: 0 -27px -23px;\r\n}\r\n.window--classic .header__avatar {\r\n float: left;\r\n margin-right: 17px;\r\n width: 45px;\r\n height: 45px;\r\n -ms-flex-item-align: start;\r\n align-self: flex-start;\r\n}\r\n.window--classic .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 45px;\r\n height: 45px;\r\n}\r\n.window--classic .header__agent {\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n max-width: 100%;\r\n -webkit-box-flex: 0;\r\n -ms-flex-positive: 0;\r\n flex-grow: 0;\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n}\r\n.window--classic .header__agentName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--classic .header__agentTitle {\r\n font-size: 0.8rem;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n overflow: hidden;\r\n white-space: nowrap;\r\n text-overflow: ellipsis;\r\n}\r\n.window--classic .header__agentBio {\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n opacity: 0.8;\r\n margin-top: 4px;\r\n padding-left: 60px;\r\n padding-bottom: 2px;\r\n margin-bottom: -2px;\r\n max-height: 84px;\r\n overflow-y: auto;\r\n}\r\n.window--classic .header__logo {\r\n margin-left: auto;\r\n margin-top: 9px;\r\n margin-bottom: 5px;\r\n}\r\n.window--classic .header__logoImg {\r\n max-height: 45px;\r\n max-width: 100px;\r\n display: block;\r\n float: right;\r\n width: auto;\r\n height: auto;\r\n}\r\n.window--classic .header__teamName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-align: center;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n width: 100%;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n margin-bottom: 8px;\r\n}\r\n.window--classic .header__teamAvatar {\r\n position: relative;\r\n width: 142px;\r\n height: 40px;\r\n margin: 9px auto;\r\n}\r\n.window--classic .header__teamAvatarImg {\r\n position: absolute;\r\n width: 40px;\r\n height: 40px;\r\n border-radius: 100%;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(1) {\r\n left: 0;\r\n z-index: 9;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(2) {\r\n left: 49px;\r\n z-index: 8;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(3) {\r\n left: 99px;\r\n z-index: 7;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","customCSSOfCircle":".window--circle .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 40px);\r\n margin: 0 0 -15px -20px;\r\n}\r\n.window--circle .header__avatar {\r\n position: absolute;\r\n top: -69.5px;\r\n left: 50%;\r\n margin-left: -35px;\r\n}\r\n.window--circle .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 65px;\r\n height: 65px;\r\n margin: 0 auto;\r\n}\r\n.window--circle .header__agentName {\r\n max-width: calc(100% - 90px);\r\n margin: 0 auto;\r\n font-size: 1.13333333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--circle .header__agentTitle {\r\n font-size: 0.8rem;\r\n margin-top: 2px;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n}\r\n.window--circle .header__agentBio {\r\n text-align: center;\r\n margin-top: 2px;\r\n margin-bottom: 1px;\r\n padding-bottom: 2px;\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n display: -webkit-box;\r\n max-height: 70px;\r\n -webkit-line-clamp: 4;\r\n -webkit-box-orient: vertical;\r\n width: 100%;\r\n opacity: 0.8;\r\n overflow-y: auto;\r\n}\r\n.window--circle .header__teamName {\r\n font-size: 1.133333333333333rem;\r\n line-height: 1.29;\r\n margin-top: 21px;\r\n text-align: center;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n}\r\n.window--circle .header__teamAvatar {\r\n position: absolute;\r\n left: 50%;\r\n top: -22px;\r\n width: 112px;\r\n height: 42px;\r\n margin-bottom: 10px;\r\n margin-left: -56px;\r\n -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\r\n both;\r\n animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\r\n -webkit-animation-delay: 0.3s;\r\n animation-delay: 0.3s;\r\n}\r\n.window--circle .header__teamAvatarImg {\r\n position: absolute;\r\n width: 44px;\r\n height: 44px;\r\n border: 2px solid #fff;\r\n border-radius: 100%;\r\n top: 0;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(1) {\r\n z-index: 8;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(2) {\r\n left: 36px;\r\n z-index: 9;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(3) {\r\n right: 0;\r\n z-index: 10;\r\n}\r\n.window--circle .window__headerBox {\r\n border-bottom: 1px solid #ddd;\r\n width: calc(100% - 40px);\r\n margin: 0 auto;\r\n padding-left: 0;\r\n padding-right: 0;\r\n padding-bottom: 15px;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","isTranscriptDownloadAllowed":true,"isTranscriptSentToVisitors":true,"isTranscriptSentFromCurrentAgentEmail":true,"fromEmailName":"comm100User","fromEmailAddress":"comm100User@comm100.com","isSMTPServerCustomized":true,"customSMTPServerFromName":"user","customSMTPServerFromEmail":"user@thirdparty.com","customSMTPServerFromMailServer":"smtp.office365.com","customSMTPServerPort":25,"customSMTPServerEncryptedType":"ssl","isAuthenticationRequiredForCustomSMTPServer":false,"customSMTPServerUserName":"admin","customSMTPServerPassword":"password","ifAllowToSwitchToOfflineMessage":true,"ifAllowToSendFile":true,"ifMarkUnreadMessage":true,"isAudioChatEnabled":false,"isVideoChatEnabled":false,"isBrowserPopupNotificationEnabled":false,"ifEndChatWhenVisitorIsInactive":true,"minutesOfVisitorInactivity":"Mins15","isTranscriptSentForArchiving":false,"receivingEmailAddressesForArchivingTranscripts":["user@comm100.com"],"emailSubjectForArchivingTranscripts":"subject","greetingMessage":"<p>Hello, how can I help you?</p>","isCustomJSEnabled":true,"customJS":"Comm100API.on('livechat.chat.agent.join', function(agent) { console.log(agent) });\r\nComm100API.on('livechat.chat.agent.leave', function(agent) { console.log(agent) });","isTranscriptPrintAllowed":true,"isChatQueueMaxLengthEnabled":true,"chatQueueMaxLength":1,"chatQueueMaxWaitTime":60,"chatQueueLimitsMessage":"5","circleStyleHeaderType":"agent","popupChatWindowTitle":"Comm100 Live Chat - Chat Window","bannerImageSource":"fromGallery","logoImageSource":"fromGallery","builtinChatWindowLogoId":"3708e087-fe96-4f38-8874-d14024341fff","builtinChatWindowBannerImageId":"8dcab40f-2d1c-4c3d-a6b6-87b6ddad9d3e","ifRemovePoweredBy":true}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"27792c81-38d2-4398-ba40-bafc804ffd2d","style":"classic","color":"#329FD9","type":"embeddedChatWindow","classicStyleHeaderType":"agent","isAvatarDisplayed":true,"isTitleDisplayed":true,"isBioDisplayed":true,"isLogoDisplayed":true,"customLogoImage":"https://api15.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customLogoImage","customBannerImage":"https://api15.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customBannerImage","isAvatarDisplayedWithMessage":true,"isBackgroundDisplayed":true,"backgroundTexture":"style1","customCSSOfClassic":".window--classic .window__headerBox {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n}\r\n.window--classic .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 54px);\r\n margin: 0 -27px -23px;\r\n}\r\n.window--classic .header__avatar {\r\n float: left;\r\n margin-right: 17px;\r\n width: 45px;\r\n height: 45px;\r\n -ms-flex-item-align: start;\r\n align-self: flex-start;\r\n}\r\n.window--classic .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 45px;\r\n height: 45px;\r\n}\r\n.window--classic .header__agent {\r\n -webkit-box-align: center;\r\n -ms-flex-align: center;\r\n align-items: center;\r\n max-width: 100%;\r\n -webkit-box-flex: 0;\r\n -ms-flex-positive: 0;\r\n flex-grow: 0;\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n}\r\n.window--classic .header__agentName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--classic .header__agentTitle {\r\n font-size: 0.8rem;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n overflow: hidden;\r\n white-space: nowrap;\r\n text-overflow: ellipsis;\r\n}\r\n.window--classic .header__agentBio {\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n opacity: 0.8;\r\n margin-top: 4px;\r\n padding-left: 60px;\r\n padding-bottom: 2px;\r\n margin-bottom: -2px;\r\n max-height: 84px;\r\n overflow-y: auto;\r\n}\r\n.window--classic .header__logo {\r\n margin-left: auto;\r\n margin-top: 9px;\r\n margin-bottom: 5px;\r\n}\r\n.window--classic .header__logoImg {\r\n max-height: 45px;\r\n max-width: 100px;\r\n display: block;\r\n float: right;\r\n width: auto;\r\n height: auto;\r\n}\r\n.window--classic .header__teamName {\r\n font-size: 1.133333rem;\r\n line-height: 1.29;\r\n text-align: center;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n width: 100%;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n margin-bottom: 8px;\r\n}\r\n.window--classic .header__teamAvatar {\r\n position: relative;\r\n width: 142px;\r\n height: 40px;\r\n margin: 9px auto;\r\n}\r\n.window--classic .header__teamAvatarImg {\r\n position: absolute;\r\n width: 40px;\r\n height: 40px;\r\n border-radius: 100%;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(1) {\r\n left: 0;\r\n z-index: 9;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(2) {\r\n left: 49px;\r\n z-index: 8;\r\n}\r\n.window--classic .header__teamAvatarImg:nth-child(3) {\r\n left: 99px;\r\n z-index: 7;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","customCSSOfCircle":".window--circle .header__bannerImg {\r\n display: block;\r\n max-width: calc(100% + 40px);\r\n margin: 0 0 -15px -20px;\r\n}\r\n.window--circle .header__avatar {\r\n position: absolute;\r\n top: -69.5px;\r\n left: 50%;\r\n margin-left: -35px;\r\n}\r\n.window--circle .header__avatarImage {\r\n display: block;\r\n border-radius: 100%;\r\n width: 65px;\r\n height: 65px;\r\n margin: 0 auto;\r\n}\r\n.window--circle .header__agentName {\r\n max-width: calc(100% - 90px);\r\n margin: 0 auto;\r\n font-size: 1.13333333rem;\r\n line-height: 1.29;\r\n text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\r\n}\r\n.window--circle .header__agentTitle {\r\n font-size: 0.8rem;\r\n margin-top: 2px;\r\n line-height: 1.25;\r\n opacity: 0.5;\r\n}\r\n.window--circle .header__agentBio {\r\n text-align: center;\r\n margin-top: 2px;\r\n margin-bottom: 1px;\r\n padding-bottom: 2px;\r\n font-size: 0.8rem;\r\n line-height: 1.17;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n display: -webkit-box;\r\n max-height: 70px;\r\n -webkit-line-clamp: 4;\r\n -webkit-box-orient: vertical;\r\n width: 100%;\r\n opacity: 0.8;\r\n overflow-y: auto;\r\n}\r\n.window--circle .header__teamName {\r\n font-size: 1.133333333333333rem;\r\n line-height: 1.29;\r\n margin-top: 21px;\r\n text-align: center;\r\n overflow: hidden;\r\n text-overflow: ellipsis;\r\n white-space: nowrap;\r\n}\r\n.window--circle .header__teamAvatar {\r\n position: absolute;\r\n left: 50%;\r\n top: -22px;\r\n width: 112px;\r\n height: 42px;\r\n margin-bottom: 10px;\r\n margin-left: -56px;\r\n -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\r\n both;\r\n animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\r\n -webkit-animation-delay: 0.3s;\r\n animation-delay: 0.3s;\r\n}\r\n.window--circle .header__teamAvatarImg {\r\n position: absolute;\r\n width: 44px;\r\n height: 44px;\r\n border: 2px solid #fff;\r\n border-radius: 100%;\r\n top: 0;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(1) {\r\n z-index: 8;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(2) {\r\n left: 36px;\r\n z-index: 9;\r\n}\r\n.window--circle .header__teamAvatarImg:nth-child(3) {\r\n right: 0;\r\n z-index: 10;\r\n}\r\n.window--circle .window__headerBox {\r\n border-bottom: 1px solid #ddd;\r\n width: calc(100% - 40px);\r\n margin: 0 auto;\r\n padding-left: 0;\r\n padding-right: 0;\r\n padding-bottom: 15px;\r\n}\r\n.window__chatSystemMessage {\r\n font-size: 1rem;\r\n text-align: center;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n word-wrap: break-word;\r\n}\r\n.window__chatAgent,\r\n.window__chatVisitor {\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\r\n position: relative;\r\n}\r\n.window__chatVisitor {\r\n -webkit-box-orient: horizontal;\r\n -webkit-box-direction: reverse;\r\n -ms-flex-direction: row-reverse;\r\n flex-direction: row-reverse;\r\n}\r\n.window__chatAgentMessage,\r\n.window__chatVisitorMessage {\r\n position: relative;\r\n font-size: 0.93333333rem;\r\n line-height: 1.57;\r\n padding: 17px 22px 19px;\r\n word-wrap: break-word;\r\n word-break: break-word;\r\n border-radius: 5px;\r\n}\r\n.window__chatVisitorMessage {\r\n margin-left: 67px;\r\n max-width: calc(100% - 67px);\r\n background-color: #329fd9;\r\n border-bottom-right-radius: 0;\r\n}\r\n.window__chatAgentMessage {\r\n border-bottom-left-radius: 0;\r\n background: #f5f7f9;\r\n}\r\n.chat-time {\r\n opacity: 0;\r\n font-size: 0.8rem;\r\n background: rgba(0, 0, 0, 0.6);\r\n padding: 0 5px;\r\n line-height: 17px;\r\n height: 17px;\r\n border-radius: 8px;\r\n transition: opacity 50ms linear;\r\n position: absolute;\r\n z-index: 1;\r\n}\r\n.chat-input__controlbox {\r\n padding: 10px 10px 10px 0;\r\n display: -webkit-box;\r\n display: -ms-flexbox;\r\n display: flex;\r\n}\r\n.window__chatSender {\r\n position: absolute;\r\n right: 26px;\r\n bottom: 16px;\r\n width: 20px;\r\n height: 20px;\r\n border: none;\r\n background: 0 0;\r\n -webkit-animation: fadeIn 0.5s;\r\n animation: fadeIn 0.5s;\r\n}\r\n.footer {\r\n -ms-flex-negative: 0;\r\n flex-shrink: 0;\r\n z-index: 999;\r\n width: 100%;\r\n padding-left: 15px;\r\n padding-right: 15px;\r\n font-size: 0.8rem;\r\n height: 23px;\r\n background: 0 0;\r\n border-radius: 0 0 5px 5px;\r\n}\r\nbody,\r\nhtml {\r\n margin: 0;\r\n}\r\nhtml {\r\n position: fixed;\r\n left: 0;\r\n right: 0;\r\n top: 0;\r\n bottom: 0;\r\n font-size: 15px;\r\n -webkit-text-size-adjust: 100%;\r\n}\r\nbody {\r\n font-family: \"SourceSans Pro\", Arial;\r\n line-height: 1.42857143;\r\n overflow: hidden;\r\n}","isTranscriptDownloadAllowed":true,"isTranscriptSentToVisitors":true,"isTranscriptSentFromCurrentAgentEmail":true,"fromEmailName":"comm100User","fromEmailAddress":"comm100User@comm100.com","isSMTPServerCustomized":true,"customSMTPServerFromName":"user","customSMTPServerFromEmail":"user@thirdparty.com","customSMTPServerFromMailServer":"smtp.office365.com","customSMTPServerPort":25,"customSMTPServerEncryptedType":"ssl","isAuthenticationRequiredForCustomSMTPServer":false,"customSMTPServerUserName":"admin","customSMTPServerPassword":"password","ifAllowToSwitchToOfflineMessage":true,"ifAllowToSendFile":true,"ifMarkUnreadMessage":true,"isAudioChatEnabled":false,"isVideoChatEnabled":false,"isBrowserPopupNotificationEnabled":false,"ifEndChatWhenVisitorIsInactive":true,"minutesOfVisitorInactivity":"Mins15","isTranscriptSentForArchiving":false,"receivingEmailAddressesForArchivingTranscripts":["user@comm100.com"],"emailSubjectForArchivingTranscripts":"subject","greetingMessage":"<p>Hello, how can I help you?</p>","isCustomJSEnabled":true,"customJS":"Comm100API.on('livechat.chat.agent.join', function(agent) { console.log(agent) });\r\nComm100API.on('livechat.chat.agent.leave', function(agent) { console.log(agent) });","isTranscriptPrintAllowed":true,"isChatQueueMaxLengthEnabled":true,"chatQueueMaxLength":1,"chatQueueMaxWaitTime":60,"chatQueueLimitsMessage":"5","circleStyleHeaderType":"agent","popupChatWindowTitle":"Comm100 Live Chat - Chat Window","bannerImageSource":"fromGallery","logoImageSource":"fromGallery","builtinChatWindowLogoId":"3708e087-fe96-4f38-8874-d14024341fff","builtinChatWindowBannerImageId":"8dcab40f-2d1c-4c3d-a6b6-87b6ddad9d3e","ifRemovePoweredBy":true,"builtinChatWindowBannerImage":{"id":"AB6CFF58-C148-EB11-8100-00155D081D0B","bannerImage":"https://api15.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage","order":1,"isVisible":true},"builtinChatWindowLogo":{"id":"B86CFF58-C148-EB11-8100-00155D081D0B","logoImage":"https://api15.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage","order":1}}
Model
Chat Window Banner Gallery Image JSON Format

Chat Window Banner Gallery Image is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the chat window banner gallery image.
order integer Order of the chat window banner gallery image.
isVisible bool Whether the chat window gallery image is visibled or not.
bannerImage string Image file key of banner, available when classicStyleHeaderType is banner.
Endpoint
Get the list of Chat Window Banner Gallery Images

GET livechat/chatWindowBannerGalleryImages

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/chatWindowBannerGalleryImages \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"AB6CFF58-C148-EB11-8100-00155D081D0B","bannerImage":"https://api15.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage","order":1,"isVisible":true}]
Get a single Chat Window Banner Gallery Image

GET livechat/chatWindowBannerGalleryImages/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"AB6CFF58-C148-EB11-8100-00155D081D0B","bannerImage":"https://api15.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage","order":1,"isVisible":true}
Model
Chat Window Logo Gallery Image JSON Format

Chat Window Logo Gallery Image is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the chat window logo gallery image.
order integer Order of the chat window logo gallery image.
logoImage string Image file key of logo, available when classicStyleHeaderType is logo.
Endpoint
Get the list of Chat Window Logo Gallery Images

GET livechat/chatWindowLogoGalleryImages

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/chatWindowLogoGalleryImages \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"B86CFF58-C148-EB11-8100-00155D081D0B","logoImage":"https://api15.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage","order":1}]
Get a single Chat Window Logo Gallery Image

GET livechat/chatWindowLogoGalleryImages/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"B86CFF58-C148-EB11-8100-00155D081D0B","logoImage":"https://api15.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage","order":1}
Model
Pre-chat JSON Format

Pre-chat is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
isEnabled bool Whether pre-chat is enabled or not.
isTeamNameDisplayed bool Whether the team name is displayed or not.
isAgentAvatarDisplayed bool Whether the agent avatar is displayed or not.
greetingMessage string Content of the greeting message.
facebookLogin bool Whether facebook login is enabled or not.
isVisitorInfoRecorded bool Whether pre-chat info is remembered or not.
formFieldLayoutStyle string The layout style of the field display.Allowed values are "leftofInput", "aboveInput".
displayTeamName string Team name displayed in the header.
isGoogleReCaptchaEnabled bool Whether Google reCAPTCHA is enabled or not.
captchaLabelText string Label text of the Google reCAPTCHA.
popUpPreChatTitle string Title of the popup window.
isInputAreaEnabledWhenUsedInPreChat bool Whether the input area is enabled or not, only available when the type is taskbot.
type string Allowed values are "form", "taskbot".
taskbotId guid Id of the taskbot.
preChatFormFields preChatFormFields[] Reference to Pre-chat Form Field.
Endpoint
Get a single Pre-chat

GET livechat/campaigns/{id}/preChat

Parameters:
Name Type In Required Description
include string query no Allowed value is "preChatFormField".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/preChat \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","isEnabled":true,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"id":"53e75029-e629-46c8-92ab-293a606e1b70","campaignId":"096e00d3-bf5b-4da4-9aa9-299e7501acaf","fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]}
Disable the Pre-chat

POST livechat/campaigns/{id}/preChat:disable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/preChat:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","isEnabled":false,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"id":"53e75029-e629-46c8-92ab-293a606e1b70","campaignId":"096e00d3-bf5b-4da4-9aa9-299e7501acaf","fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]}
Enable the Pre-chat

POST livechat/campaigns/{id}/preChat:enable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/preChat:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","isEnabled":true,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"id":"53e75029-e629-46c8-92ab-293a606e1b70","campaignId":"096e00d3-bf5b-4da4-9aa9-299e7501acaf","fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]}
Update the Pre-chat

PUT livechat/campaigns/{id}/preChat

Parameters:
Name Type In Required Description
isEnabled bool body no Whether pre-chat is enabled or not.
isTeamNameDisplayed bool body no Whether the team name is displayed or not.
isAgentAvatarDisplayed bool body no Whether the agent avatar is displayed or not.
greetingMessage string body no Content of the greeting message.
facebookLogin bool body no Whether facebook login is enabled or not.
isVisitorInfoRecorded bool body no Whether pre-chat info is remembered or not.
formFieldLayoutStyle string body no The layout style of the field display.Allowed values are "leftofInput", "aboveInput".
displayTeamName string body yes Team name displayed in the header.
isGoogleReCaptchaEnabled bool body no Whether Google reCAPTCHA is enabled or not.
captchaLabelText string body yes Label text of the Google reCAPTCHA.
popUpPreChatTitle string body yes Title of the popup window.
isInputAreaEnabledWhenUsedInPreChat bool body yes Whether the input area is enabled or not, only available when the type is taskbot.
type string body yes Allowed values are "form", "taskbot".
taskbotId guid body no Id of the taskbot.
preChatFormFields preChatFormFields[] body no Reference to Pre-chat Form Field.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/preChat \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":true,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"ifDisplayinRoutingRule":true,"ifDisplayinVisitorSSOMapping":true,"ifDisplayinSalesforceMapping":true,"ifDisplayinTicketMapping":true,"ifDisplayinCannedMessage":true}]}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","isEnabled":true,"isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"greetingMessage":"Welcome to our website. We are excited to chat with you!","facebookLogin":false,"isVisitorInfoRecorded":true,"formFieldLayoutStyle":"aboveInput","displayTeamName":"Our Team","isGoogleReCaptchaEnabled":true,"captchaLabelText":"Captcha","popUpPreChatTitle":"Comm100 Live Chat - Pre-Chat Window","isInputAreaEnabledWhenUsedInPreChat":true,"type":"form","taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","preChatFormFields":[{"id":"53e75029-e629-46c8-92ab-293a606e1b70","campaignId":"096e00d3-bf5b-4da4-9aa9-299e7501acaf","fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]}
Model
Pre-chat Form Field JSON Format

Pre-chat Form Field is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the pre chat form field.
campaignId guid Id of the campaign.
fieldId guid Id of the field.
label string The label of the field.
isVisible bool Whether the field displayed or not.
isRequired bool Whether the field required or not.
order integer Order of the field.
field field Reference to Field.
Endpoint
Get the list of Pre-chat Form Fields

GET livechat/preChatFormFields

Parameters:
Name Type In Required Description
isSystem bool query no Whether the field is visible or not.
Response:

An array of   Pre-chat Form Field

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/preChatFormFields \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"53e75029-e629-46c8-92ab-293a606e1b70","campaignId":"096e00d3-bf5b-4da4-9aa9-299e7501acaf","fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]
Get a single Pre-chat Form Field

GET livechat/preChatFormFields/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/preChatFormFields/53e75029-e629-46c8-92ab-293a606e1b70 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"53e75029-e629-46c8-92ab-293a606e1b70","campaignId":"096e00d3-bf5b-4da4-9aa9-299e7501acaf","fieldId":"{\"id\":\"4c05589f-8a4f-4384-8c21-4d7ac5ba30fc\",\"campaignId\":\"096e00d3-bf5b-4da4-9aa9-299e7501acaf\",\"fieldId\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"label\":\"Email\",\"isVisible\":true,\"isRequired\":true,\"order\":2,\"ifDisplayinRoutingRule\":true,\"ifDisplayinVisitorSSOMapping\":false,\"ifDisplayinSalesforceMapping\":false,\"ifDisplayinTicketMapping\":false,\"ifDisplayinCannedMessage\":false,\"field\":{\"id\":\"60da9308-e890-4424-ada5-ed95f0b574f6\",\"isSystem\":true,\"name\":\"Email\",\"type\":\"text\",\"leftText\":\"\",\"rightText\":\"\",\"fieldOptions\":[]}}","label":"Inquiry Relate","isVisible":true,"isRequired":true,"order":3,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}
Model
Canned Message JSON Format

Canned Message is represented as simple flat JSON objects with the following keys:

Name Type Description
isEnabled bool Whether canned message is enabled or not.
campaignId guid Id of the campaign.
publicCannedMessageCategoryIds array The list of the canned message config identifiers of campaign, which the public canned message category is related to.
Endpoint
Get a single Canned Message

GET livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig

Parameters:
Name Type In Required Description
include string query no Allowed values are "publicCannedMessageCategory", "campaignLanguage".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/2226CBDF-B7B1-4CBB-902D-62314A1D4576/campaignLinkingToCannedMessageCategoriesConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"campaignId":"2226CBDF-B7B1-4CBB-902D-62314A1D4576","publicCannedMessageCategoryIds":["6fd98c99-f183-4247-bdda-47491426e577"]}
Disable the Canned Message

POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:disable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/2226CBDF-B7B1-4CBB-902D-62314A1D4576/campaignLinkingToCannedMessageCategoriesConfig:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":false,"campaignId":"2226CBDF-B7B1-4CBB-902D-62314A1D4576","publicCannedMessageCategoryIds":["6fd98c99-f183-4247-bdda-47491426e577"]}
Enable the Canned Message

POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:enable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/2226CBDF-B7B1-4CBB-902D-62314A1D4576/campaignLinkingToCannedMessageCategoriesConfig:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"campaignId":"2226CBDF-B7B1-4CBB-902D-62314A1D4576","publicCannedMessageCategoryIds":["6fd98c99-f183-4247-bdda-47491426e577"]}
Update the Canned Message

PUT livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether canned message is enabled or not.
publicCannedMessageCategoryIds array body no The list of the canned message config identifiers of campaign, which the public canned message category is related to.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/2226CBDF-B7B1-4CBB-902D-62314A1D4576/campaignLinkingToCannedMessageCategoriesConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":true}'

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"campaignId":"2226CBDF-B7B1-4CBB-902D-62314A1D4576","publicCannedMessageCategoryIds":["6fd98c99-f183-4247-bdda-47491426e577"]}
Model
Offline Message JSON Format

Offline Message is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign which the chat window belongs to.
type string Allowed values are "systemOfflineMessageWindow", "customOfflineMessagePage", "triggerTaskbot".
customOfflineMessagePageURL string URL of custom offline message page.
ifOpenCustomOfflineMessagePageInNewWindow bool Whether to open the custom offline message page in a new window or not.
greetingMessage string Content of the greeting message.
emailOfflineMessageTo string Allowed values are "allAgent", "customEmailAddress".
customEmailAddresses string Customize the offline message receiving mailbox
isTeamNameDisplayed bool Whether the name of the agent is visible or not in the header.
isAgentAvatarDisplayed bool Whether the avatar of the agent is visible or not in the header.
displayTeamName string The team name displayed in the header.
formFieldLayoutStyle string Allowed values are "leftofInput", "aboveInput".
popUpOfflineMessageTitle string Pop Up offline message Title.
isInputAreaEnabledWhenUsedInOfflineMessage bool Whether the input area is enabled or not, only available when the type is trigger taskbot.
taskbotId guid Id of the taskbot.
fieldResults offlineMessageFormFields[] Reference to Offline Message Form Field.
Endpoint
Get a single Offline Message

GET livechat/campaigns/{id}/offlineMessageConfig

Parameters:
Name Type In Required Description
include string query no Allowed value is "offlineMessageFormField".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/BFB05329-7C46-EB11-8100-00155D081D0B/offlineMessageConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"BFB05329-7C46-EB11-8100-00155D081D0B","type":"systemOfflineMessageWindow","customOfflineMessagePageURL":"https://www.google.com","ifOpenCustomOfflineMessagePageInNewWindow":true,"greetingMessage":"Please leave us a message and we will get back to you shortly.","emailOfflineMessageTo":"","customEmailAddresses":"carle3w@163.com.","isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"displayTeamName":"Our Team","formFieldLayoutStyle":"","popUpOfflineMessageTitle":"Comm100 Live Chat - Offline Message Window","isInputAreaEnabledWhenUsedInOfflineMessage":true,"taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","fieldResults":[{"id":"F6B05329-7C46-EB11-8100-00155D081D0B","campaignId":"F7B05329-7C46-EB11-8100-00155D081D0B","fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]}
Update the Offline Message

PUT livechat/campaigns/{id}/offlineMessageConfig

Parameters:
Name Type In Required Description
type string body no Allowed values are "systemOfflineMessageWindow", "customOfflineMessagePage", "triggerTaskbot".
customOfflineMessagePageURL string body yes URL of custom offline message page.
ifOpenCustomOfflineMessagePageInNewWindow bool body no Whether to open the custom offline message page in a new window or not.
greetingMessage string body no Content of the greeting message.
emailOfflineMessageTo string body no Allowed values are "allAgent", "customEmailAddress".
customEmailAddresses string body no Customize the offline message receiving mailbox
isTeamNameDisplayed bool body no Whether the name of the agent is visible or not in the header.
isAgentAvatarDisplayed bool body no Whether the avatar of the agent is visible or not in the header.
displayTeamName string body yes The team name displayed in the header.
formFieldLayoutStyle string body no Allowed values are "leftofInput", "aboveInput".
popUpOfflineMessageTitle string body yes Pop Up offline message Title.
isInputAreaEnabledWhenUsedInOfflineMessage bool body yes Whether the input area is enabled or not, only available when the type is trigger taskbot.
taskbotId guid body no Id of the taskbot.
offlineMessageFormFields offlineMessageFormFields[] body no Reference to Offline Message Form Field.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/BFB05329-7C46-EB11-8100-00155D081D0B/offlineMessageConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"type":"systemOfflineMessageWindow","customOfflineMessagePageURL":"https://www.google.com","ifOpenCustomOfflineMessagePageInNewWindow":true,"greetingMessage":"Please leave us a message and we will get back to you shortly.","emailOfflineMessageTo":"","customEmailAddresses":"carle3w@163.com.","isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"displayTeamName":"Our Team","formFieldLayoutStyle":"","popUpOfflineMessageTitle":"Comm100 Live Chat - Offline Message Window","isInputAreaEnabledWhenUsedInOfflineMessage":true,"taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","offlineMessageFormFields":[{"fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"ifDisplayinTicketMapping":true}]}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"BFB05329-7C46-EB11-8100-00155D081D0B","type":"systemOfflineMessageWindow","customOfflineMessagePageURL":"https://www.google.com","ifOpenCustomOfflineMessagePageInNewWindow":true,"greetingMessage":"Please leave us a message and we will get back to you shortly.","emailOfflineMessageTo":"","customEmailAddresses":"carle3w@163.com.","isTeamNameDisplayed":true,"isAgentAvatarDisplayed":true,"displayTeamName":"Our Team","formFieldLayoutStyle":"","popUpOfflineMessageTitle":"Comm100 Live Chat - Offline Message Window","isInputAreaEnabledWhenUsedInOfflineMessage":true,"taskbotId":"c44fada7-961b-42fd-abac-d080355f6ed6","fieldResults":[{"id":"F6B05329-7C46-EB11-8100-00155D081D0B","campaignId":"F7B05329-7C46-EB11-8100-00155D081D0B","fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]}
Model
Offline Message Form Field JSON Format

Offline Message Form Field is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the field.
campaignId guid Id of the campaign which the offline message belongs to.
fieldId guid Id of the field which the offline message belongs to.
label string Label of the offline message field.
isVisible bool Whether offline message form field is visible or not.
isRequired bool Whether offline message form field is required or not.
order integer Order of the option.
field field Reference to Field.
Endpoint
Get the list of Offline Message Form Fields

GET livechat/offlineMessageFormFields

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/offlineMessageFormFields \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"F6B05329-7C46-EB11-8100-00155D081D0B","campaignId":"F7B05329-7C46-EB11-8100-00155D081D0B","fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}]
Get a single Offline Message Form Field

GET livechat/offlineMessageFormFields/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/offlineMessageFormFields/F6B05329-7C46-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"F6B05329-7C46-EB11-8100-00155D081D0B","campaignId":"F7B05329-7C46-EB11-8100-00155D081D0B","fieldId":"F8B05329-7C46-EB11-8100-00155D081D0B","label":"color","isVisible":true,"isRequired":true,"order":1,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]}}
Model
Post-chat JSON Format

Post-chat is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
greetingMessage string Greeting message of post-chat.
isEnabled bool Whether post-chat is enabled or not.
formFieldLayoutStyle string Allowed values are "leftofInput", "aboveInput".
postChatFormFields postChatFormFields[] Reference to Post Chat Form Field.
Endpoint
Get a single Post-chat

GET livechat/campaigns/{id}/postChat

Parameters:
Name Type In Required Description
include string query no Allowed value is "postChatFormField".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/postChat \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":true,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"id":"694CB583-B475-4704-863D-A9C85797164C","campaignId":"D440C709-966B-46DB-A2EF-348EA2A68011","fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]},"ratingGrades":[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]}
Disable the Post-chat

POST livechat/campaigns/{id}/postChat:disable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/postChat:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":false,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"id":"694CB583-B475-4704-863D-A9C85797164C","campaignId":"D440C709-966B-46DB-A2EF-348EA2A68011","fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]},"ratingGrades":[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]}
Enable the Post-chat

POST livechat/campaigns/{id}/postChat:enable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/postChat:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":true,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"id":"694CB583-B475-4704-863D-A9C85797164C","campaignId":"D440C709-966B-46DB-A2EF-348EA2A68011","fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]},"ratingGrades":[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]}
Update the Post-chat

PUT livechat/campaigns/{id}/postChat

Parameters:
Name Type In Required Description
greetingMessage string body no Greeting message of post-chat.
isEnabled bool body no Whether post-chat is enabled or not.
formFieldLayoutStyle string body no Allowed values are "leftofInput", "aboveInput".
postChatFormFields postChatFormFields[] body no Reference to Post Chat Form Field.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/postChat \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":true,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"ratingGrades":[{"grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","greetingMessage":"Please comment on our service performance so that we can serve you better. Thanks for your time!","isEnabled":true,"formFieldLayoutStyle":"aboveInput","postChatFormFields":[{"id":"694CB583-B475-4704-863D-A9C85797164C","campaignId":"D440C709-966B-46DB-A2EF-348EA2A68011","fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]},"ratingGrades":[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]}
Model
Post Chat Form Field JSON Format

Post Chat Form Field is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the post chat form field.
campaignId guid Id of the campaign.
fieldId guid Id of the field.
label string Label of the field.
isVisible bool Whether the post chat form field is visible or not.
isRequired bool Whether the post chat form field is required or not.
order integer Order of the post chat form field.
field field Reference to Field.
ratingGrades ratingGrades[] Reference to Rating Grade.
Endpoint
Get the list of Post Chat Form Fields

GET livechat/postChatFormFields

Parameters:
Name Type In Required Description
include string query no Allowed value is "campaignRatingGrade".
Response:

An array of   Post Chat Form Field

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/postChatFormFields \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"694CB583-B475-4704-863D-A9C85797164C","campaignId":"D440C709-966B-46DB-A2EF-348EA2A68011","fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]},"ratingGrades":[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}]
Get a single Post Chat Form Field

GET livechat/postChatFormFields/{id}

Parameters:
Name Type In Required Description
include string query no Allowed value is "campaignRatingGrade".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/postChatFormFields/694CB583-B475-4704-863D-A9C85797164C \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"694CB583-B475-4704-863D-A9C85797164C","campaignId":"D440C709-966B-46DB-A2EF-348EA2A68011","fieldId":"2EA124EE-B318-497F-A018-63987E2C290B","label":"Rating","isVisible":true,"isRequired":true,"order":2,"field":{"id":"a03cce30-f892-4286-8b7e-8e6c39cb4d19","isSystem":false,"name":"Pre-textarea","type":"radioBox","leftText":"Highly unlikely","rightText":"Highly likely","fieldOptions":[{"id":"314a02b2-cb4c-418f-b9bc-84fb4ad84254","fieldId":"ca092d3f-21eb-492f-9142-205101b1d08a","parentOptionId":"fa3e2d7b-cadb-47c1-ad7e-ef387907ec41","value":"Text 2","order":0}]},"ratingGrades":[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]}
Model
Rating Grade JSON Format

Rating Grade is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the rating grade.
postChatFormFieldId guid Id of the field.
grade string Allowed values are "Scale 1", "Scale 2", "Scale 3", "Scale 4", "Scale 5".
label string The label of the rating grade.
isVisible bool Whether the rating grade displayed or not.
Endpoint
Get the list of Rating Grades

GET livechat/ratingGrades

Parameters:
No Parameters
Response:

An array of   Rating Grade

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/ratingGrades \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}]
Get a single Rating Grade

GET livechat/ratingGrades/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/ratingGrades/9f080466-9023-4516-9e65-3dec0b4d0016 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}
Update the Rating Grade

PUT livechat/ratingGrades/{id}

Parameters:
Name Type In Required Description
postChatFormFieldId guid body no Id of the field.
grade string body no Allowed values are "Scale 1", "Scale 2", "Scale 3", "Scale 4", "Scale 5".
label string body no The label of the rating grade.
isVisible bool body no Whether the rating grade displayed or not.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/ratingGrades/9f080466-9023-4516-9e65-3dec0b4d0016 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}'

Response:

 HTTP/1.1 200 OK

{"id":"9f080466-9023-4516-9e65-3dec0b4d0016","postChatFormFieldId":"37f769ea-3fdc-411e-90f9-9a9001e8b0f8","grade":"9f080466-9023-4516-9e65-3dec0b4d0016","label":"Excellent","isVisible":true}
Model
KB Integration JSON Format

KB Integration is represented as simple flat JSON objects with the following keys:

Name Type Description
isEnabled bool Whether KB integration is enabled or not.
selectedKbId guid Id of the selected KB.
isSearchAllowedBeforeChatting bool Whether allow search KB before chatting or not.
isSearchAllowedBeforeOfflineMessage bool Whether allow search KB before leaving a message or not.
articlesShowedInSearchResult integer Maximum number of articles showed in search result.
greetingMessageBeforeChatting string The greeting message before chatting.
greetingMessageBeforeOfflineMessage string The greeting message before leaving a message.
campaignId guid Id of the campaign.
Endpoint
Get a single KB Integration

GET livechat/campaigns/{id}/integrationKbConfig

Parameters:
Name Type In Required Description
include string query no Allowed value is "knowledgeBase".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/77AF5329-7C46-EB11-8100-00155D081D0B/integrationKbConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":false,"selectedKbId":"6AAF5329-7C46-EB11-8100-00155D081D0B","isSearchAllowedBeforeChatting":true,"isSearchAllowedBeforeOfflineMessage":true,"articlesShowedInSearchResult":5,"greetingMessageBeforeChatting":"Search Knowledge Base","greetingMessageBeforeOfflineMessage":"Search Knowledge Base","campaignId":"77AF5329-7C46-EB11-8100-00155D081D0B"}
Update the KB Integration

PUT livechat/campaigns/{id}/integrationKbConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether KB integration is enabled or not.
selectedKbId guid body yes Id of the selected KB.
isSearchAllowedBeforeChatting bool body no Whether allow search KB before chatting or not.
isSearchAllowedBeforeOfflineMessage bool body no Whether allow search KB before leaving a message or not.
articlesShowedInSearchResult integer body no Maximum number of articles showed in search result.
greetingMessageBeforeChatting string body no The greeting message before chatting.
greetingMessageBeforeOfflineMessage string body no The greeting message before leaving a message.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/77AF5329-7C46-EB11-8100-00155D081D0B/integrationKbConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":false,"selectedKbId":"6AAF5329-7C46-EB11-8100-00155D081D0B","isSearchAllowedBeforeChatting":true,"isSearchAllowedBeforeOfflineMessage":true,"articlesShowedInSearchResult":5,"greetingMessageBeforeChatting":"Search Knowledge Base","greetingMessageBeforeOfflineMessage":"Search Knowledge Base"}'

Response:

 HTTP/1.1 200 OK

{"isEnabled":false,"selectedKbId":"6AAF5329-7C46-EB11-8100-00155D081D0B","isSearchAllowedBeforeChatting":true,"isSearchAllowedBeforeOfflineMessage":true,"articlesShowedInSearchResult":5,"greetingMessageBeforeChatting":"Search Knowledge Base","greetingMessageBeforeOfflineMessage":"Search Knowledge Base","campaignId":"77AF5329-7C46-EB11-8100-00155D081D0B"}
Model
Routing Rule JSON Format

Routing Rule is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
isEnabled bool Whether routing rule is enabled or not.
type string Allowed values are "simple", "customRules".
routeToTypeForSimpleRouting string Allowed values are "department", "agent".
priorityForSimpleRouting string Allowed values are "lowest", "low", "normal", "high", "highest".
percentageToBot integer Percentage to bot.
actionWhenNoRuleMatched string Allowed values are "routeToDepartmentorAgent", "redirectToOfflineMessage".
routeToTypeWhenNoRuleMatched string Allowed values are "department", "agent".
priorityWhenNoRuleMatched string Allowed values are "lowest", "low", "normal", "high", "highest".
percentageToBotWhenNoRuleMatched integer Percentage to bot when no rule matched.
emailsToReceiveOfflineMessage string [] The list of emails to receive offline message.
noRuleMatchedRouteToAgentId guid Id of the agent to be routed when visitors fail to be routed based on any of the custom rules.
simpleRoutingRouteToAgentId guid Id of the agent when route visitors to.
simpleRoutingRouteToDepartmentId guid Id of the department when route visitors to.
noRuleMatchedRouteToDepartmentId guid Id of the agent to be routed when visitors fail to be routed based on any of the custom rules.
routingRules routingRules[] Reference to Rule.
Endpoint
Get a single Routing Rule

GET livechat/campaigns/{id}/routingConfig

Parameters:
Name Type In Required Description
include string query no Allowed value is "campaignRoutingRule".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/04B15329-7C46-EB11-8100-00155D081D0B/routingConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"04B15329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"type":"simple","routeToTypeForSimpleRouting":"department","priorityForSimpleRouting":"normal","percentageToBot":0,"actionWhenNoRuleMatched":"routeToDepartmentorAgent","routeToTypeWhenNoRuleMatched":"department","priorityWhenNoRuleMatched":"normal","percentageToBotWhenNoRuleMatched":0,"emailsToReceiveOfflineMessage":["jason@comm100.com","alen@comm100.com"],"noRuleMatchedRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","noRuleMatchedRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","routingRules":[{"id":"05B15329-7C46-EB11-8100-00155D081D0B","campaignId":"13B15329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"id":"06B15329-7C46-EB11-8100-00155D081D0B","routingRuleId":"1CB15329-7C46-EB11-8100-00155D081D0B","fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}],"routeToAgent":{"id":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","email":"andy@comm100.com","displayName":"Andy Liao","firstName":"Andy","lastName":"Liao","isAdmin":true,"isActive":true,"phone":"13712345678","title":"Manager","bio":"Hello, I am Andy","timeZone":"Pacific Standard Time","datetimeFormat":"YYYY/MM/DD HH:mm:ss","createdTime":"2020-12-25T06:01:00.913Z","isLocked":true,"lockedTime":"2020-12-25T06:01:00.93Z","ifCustomizeAvatar":true,"customizeAvatar":"https://dash11.comm100dev.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111","systemAvatarId":"1383d4fd-3114-eb11-80fc-00155d081d0b","avatar":"https://api15.comm100.io/v4/Global/agents/64bb87e4-6940-4d2c-a6e4-176d52b8e9b8/avatar","permissionIds":["45A2EF45-7D46-EB11-8100-00155D081D0B"],"departmentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"],"roleIds":["e0bf1302-d145-eb11-8100-00155d081d0b"]},"routeToDepartment":{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","name":"markting","description":"markting departments","isAvailableInLiveChat":true,"isAvailableInTicketingAndMessaging":true,"offlineMessageMailTo":"toAllAgents","offlineMessageEmailAddresses":"andy@comm100.com","agentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"]}}]}
Update the Routing Rule

PUT livechat/campaigns/{id}/routingConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether routing rule is enabled or not.
type string body no Allowed values are "simple", "customRules".
routeToTypeForSimpleRouting string body no Allowed values are "department", "agent".
priorityForSimpleRouting string body yes Allowed values are "lowest", "low", "normal", "high", "highest".
percentageToBot integer body no Percentage to bot.
actionWhenNoRuleMatched string body no Allowed values are "routeToDepartmentorAgent", "redirectToOfflineMessage".
routeToTypeWhenNoRuleMatched string body no Allowed values are "department", "agent".
priorityWhenNoRuleMatched string body yes Allowed values are "lowest", "low", "normal", "high", "highest".
percentageToBotWhenNoRuleMatched integer body no Percentage to bot when no rule matched.
emailsToReceiveOfflineMessage string [] body no The list of emails to receive offline message.
noRuleMatchedRouteToAgentId guid body yes Id of the agent to be routed when visitors fail to be routed based on any of the custom rules.
simpleRoutingRouteToAgentId guid body yes Id of the agent when route visitors to.
simpleRoutingRouteToDepartmentId guid body yes Id of the department when route visitors to.
noRuleMatchedRouteToDepartmentId guid body yes Id of the agent to be routed when visitors fail to be routed based on any of the custom rules.
routingRules routingRules[] body no Reference to Rule.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/04B15329-7C46-EB11-8100-00155D081D0B/routingConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":false,"type":"simple","routeToTypeForSimpleRouting":"department","priorityForSimpleRouting":"normal","percentageToBot":0,"actionWhenNoRuleMatched":"routeToDepartmentorAgent","routeToTypeWhenNoRuleMatched":"department","priorityWhenNoRuleMatched":"normal","percentageToBotWhenNoRuleMatched":0,"emailsToReceiveOfflineMessage":["jason@comm100.com","alen@comm100.com"],"noRuleMatchedRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","noRuleMatchedRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","routingRules":[{"isEnabled":false,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}]}]}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"04B15329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"type":"simple","routeToTypeForSimpleRouting":"department","priorityForSimpleRouting":"normal","percentageToBot":0,"actionWhenNoRuleMatched":"routeToDepartmentorAgent","routeToTypeWhenNoRuleMatched":"department","priorityWhenNoRuleMatched":"normal","percentageToBotWhenNoRuleMatched":0,"emailsToReceiveOfflineMessage":["jason@comm100.com","alen@comm100.com"],"noRuleMatchedRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToAgentId":"00000000-0000-0000-0000-000000000000","simpleRoutingRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","noRuleMatchedRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","routingRules":[{"id":"05B15329-7C46-EB11-8100-00155D081D0B","campaignId":"13B15329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"id":"06B15329-7C46-EB11-8100-00155D081D0B","routingRuleId":"1CB15329-7C46-EB11-8100-00155D081D0B","fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}],"routeToAgent":{"id":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","email":"andy@comm100.com","displayName":"Andy Liao","firstName":"Andy","lastName":"Liao","isAdmin":true,"isActive":true,"phone":"13712345678","title":"Manager","bio":"Hello, I am Andy","timeZone":"Pacific Standard Time","datetimeFormat":"YYYY/MM/DD HH:mm:ss","createdTime":"2020-12-25T06:01:00.913Z","isLocked":true,"lockedTime":"2020-12-25T06:01:00.93Z","ifCustomizeAvatar":true,"customizeAvatar":"https://dash11.comm100dev.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111","systemAvatarId":"1383d4fd-3114-eb11-80fc-00155d081d0b","avatar":"https://api15.comm100.io/v4/Global/agents/64bb87e4-6940-4d2c-a6e4-176d52b8e9b8/avatar","permissionIds":["45A2EF45-7D46-EB11-8100-00155D081D0B"],"departmentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"],"roleIds":["e0bf1302-d145-eb11-8100-00155d081d0b"]},"routeToDepartment":{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","name":"markting","description":"markting departments","isAvailableInLiveChat":true,"isAvailableInTicketingAndMessaging":true,"offlineMessageMailTo":"toAllAgents","offlineMessageEmailAddresses":"andy@comm100.com","agentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"]}}]}
Model
Rule JSON Format

Rule is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the rule.
campaignId guid Id of the campaign.
isEnabled bool Whether rule is enabled or not.
order integer Order of the rule.
routeToType string Allowed values are "department", "agent".
priority string Allowed values are "lowest", "low", "normal", "high", "highest".
percentageToBot integer Percentage to bot
conditionMetType string Allowed values are "all", "any", "logicalExpression".
logicalExpression string Detail of the logic expression.
routeToDepartmentId guid Id of the department when route visitors to.
routeToAgentId guid Id of the agent when route visitors to.
name string Name of the rule.
routingRuleConditions routingRuleConditions[] Reference to Routing Rule Condition.
routeToAgent routeToAgent Reference to Agent.
routeToDepartment routeToDepartment Reference to .
Endpoint
Disable the Rule

POST livechat/routingRules/{id}:disable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/routingRules/05B15329-7C46-EB11-8100-00155D081D0B:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"05B15329-7C46-EB11-8100-00155D081D0B","campaignId":"13B15329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"id":"06B15329-7C46-EB11-8100-00155D081D0B","routingRuleId":"1CB15329-7C46-EB11-8100-00155D081D0B","fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}],"routeToAgent":{"id":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","email":"andy@comm100.com","displayName":"Andy Liao","firstName":"Andy","lastName":"Liao","isAdmin":true,"isActive":true,"phone":"13712345678","title":"Manager","bio":"Hello, I am Andy","timeZone":"Pacific Standard Time","datetimeFormat":"YYYY/MM/DD HH:mm:ss","createdTime":"2020-12-25T06:01:00.913Z","isLocked":true,"lockedTime":"2020-12-25T06:01:00.93Z","ifCustomizeAvatar":true,"customizeAvatar":"https://dash11.comm100dev.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111","systemAvatarId":"1383d4fd-3114-eb11-80fc-00155d081d0b","avatar":"https://api15.comm100.io/v4/Global/agents/64bb87e4-6940-4d2c-a6e4-176d52b8e9b8/avatar","permissionIds":["45A2EF45-7D46-EB11-8100-00155D081D0B"],"departmentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"],"roleIds":["e0bf1302-d145-eb11-8100-00155d081d0b"]},"routeToDepartment":{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","name":"markting","description":"markting departments","isAvailableInLiveChat":true,"isAvailableInTicketingAndMessaging":true,"offlineMessageMailTo":"toAllAgents","offlineMessageEmailAddresses":"andy@comm100.com","agentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"]}}
Enable the Rule

POST livechat/routingRules/{id}:enable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/routingRules/05B15329-7C46-EB11-8100-00155D081D0B:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"05B15329-7C46-EB11-8100-00155D081D0B","campaignId":"13B15329-7C46-EB11-8100-00155D081D0B","isEnabled":true,"order":0,"routeToType":"department","priority":"normal","percentageToBot":0,"conditionMetType":"all","logicalExpression":"","routeToDepartmentId":"32B25329-7C46-EB11-8100-00155D081D0B","routeToAgentId":"00000000-0000-0000-0000-000000000000","name":"rule 1","routingRuleConditions":[{"id":"06B15329-7C46-EB11-8100-00155D081D0B","routingRuleId":"1CB15329-7C46-EB11-8100-00155D081D0B","fieldName":"{!Visitor.Number of visits}","operator":"is","value":"3","order":1,"description":""}],"routeToAgent":{"id":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","email":"andy@comm100.com","displayName":"Andy Liao","firstName":"Andy","lastName":"Liao","isAdmin":true,"isActive":true,"phone":"13712345678","title":"Manager","bio":"Hello, I am Andy","timeZone":"Pacific Standard Time","datetimeFormat":"YYYY/MM/DD HH:mm:ss","createdTime":"2020-12-25T06:01:00.913Z","isLocked":true,"lockedTime":"2020-12-25T06:01:00.93Z","ifCustomizeAvatar":true,"customizeAvatar":"https://dash11.comm100dev.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111","systemAvatarId":"1383d4fd-3114-eb11-80fc-00155d081d0b","avatar":"https://api15.comm100.io/v4/Global/agents/64bb87e4-6940-4d2c-a6e4-176d52b8e9b8/avatar","permissionIds":["45A2EF45-7D46-EB11-8100-00155D081D0B"],"departmentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"],"roleIds":["e0bf1302-d145-eb11-8100-00155d081d0b"]},"routeToDepartment":{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","name":"markting","description":"markting departments","isAvailableInLiveChat":true,"isAvailableInTicketingAndMessaging":true,"offlineMessageMailTo":"toAllAgents","offlineMessageEmailAddresses":"andy@comm100.com","agentIds":["b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"]}}
Model
AI Chatbot JSON Format

AI Chatbot is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
isEnabled bool Whether bot is enabled or not.
selectedChatBotId guid Id of selected bot.
isChatbotAllocatedWhenAgentOnline bool Whether allocate chats to bot when agents are online or not.
isChatbotAllocatedWhenAgentOffline bool Whether allocate chats to bot when agents are offline or not.
distributeChatsToChatbotOption string Allowed values are "byQueueLength", "byPercentage".
queueLength integer Reached queue length to allocate when agents are online.
percentageToChatbot integer Probability of chats being distributed to bot when agents are online.
isDistributeChatsWhenQueueLengthReachesEnabled bool Whether allocate chats when queue length reaches or not.
Endpoint
Get a single AI Chatbot

GET livechat/campaigns/{id}/integrationChatBotConfig

Parameters:
Name Type In Required Description
include string query no Allowed value is "chatbot".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/66AF5329-7C46-EB11-8100-00155D081D0B/integrationChatBotConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"66AF5329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"selectedChatBotId":"15d08136-ee5c-44df-bdfd-f58877e3984b","isChatbotAllocatedWhenAgentOnline":false,"isChatbotAllocatedWhenAgentOffline":false,"distributeChatsToChatbotOption":"byQueueLength","queueLength":1,"percentageToChatbot":50,"isDistributeChatsWhenQueueLengthReachesEnabled":false}
Update the AI Chatbot

PUT livechat/campaigns/{id}/integrationChatBotConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether bot is enabled or not.
selectedChatBotId guid body yes Id of selected bot.
isChatbotAllocatedWhenAgentOnline bool body no Whether allocate chats to bot when agents are online or not.
isChatbotAllocatedWhenAgentOffline bool body no Whether allocate chats to bot when agents are offline or not.
distributeChatsToChatbotOption string body yes Allowed values are "byQueueLength", "byPercentage".
queueLength integer body yes Reached queue length to allocate when agents are online.
percentageToChatbot integer body yes Probability of chats being distributed to bot when agents are online.
isDistributeChatsWhenQueueLengthReachesEnabled bool body no Whether allocate chats when queue length reaches or not.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/66AF5329-7C46-EB11-8100-00155D081D0B/integrationChatBotConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":false,"selectedChatBotId":"15d08136-ee5c-44df-bdfd-f58877e3984b","isChatbotAllocatedWhenAgentOnline":false,"isChatbotAllocatedWhenAgentOffline":false,"distributeChatsToChatbotOption":"byQueueLength","queueLength":1,"percentageToChatbot":50,"isDistributeChatsWhenQueueLengthReachesEnabled":false}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"66AF5329-7C46-EB11-8100-00155D081D0B","isEnabled":false,"selectedChatBotId":"15d08136-ee5c-44df-bdfd-f58877e3984b","isChatbotAllocatedWhenAgentOnline":false,"isChatbotAllocatedWhenAgentOffline":false,"distributeChatsToChatbotOption":"byQueueLength","queueLength":1,"percentageToChatbot":50,"isDistributeChatsWhenQueueLengthReachesEnabled":false}
Model
Manual Invitation JSON Format

Manual Invitation is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
style string Allowed values are "bubble", "chatWindow".
invitationMessage string Message shown in manual invitation window.
Endpoint
Get a single Manual Invitation

GET livechat/campaigns/{id}/manualInvitation

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/manualInvitation \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","style":"bubble","invitationMessage":"Hello, how may I help you?"}
Update the Manual Invitation

PUT livechat/campaigns/{id}/manualInvitation

Parameters:
Name Type In Required Description
style string body yes Allowed values are "bubble", "chatWindow".
invitationMessage string body no Message shown in manual invitation window.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/manualInvitation \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"style":"bubble","invitationMessage":"Hello, how may I help you?"}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","style":"bubble","invitationMessage":"Hello, how may I help you?"}
Model
Language JSON Format

Language is represented as simple flat JSON objects with the following keys:

Name Type Description
campaignId guid Id of the campaign.
isCustomLanguageEnabled bool Whether the campaign used custom language or not.
isTextDirectionRightToLeft bool Whether the campaign's custom language text directed from right to left or not.
campaign campaign Reference to Campaign.
customLanguageItems customLanguageItems[] Reference to Custom Language.
Endpoint
Get a single Language

GET livechat/campaigns/{id}/languageConfig

Parameters:
Name Type In Required Description
include string query no Allowed values are "campaign", "campaignLanguage".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/languageConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","isCustomLanguageEnabled":false,"isTextDirectionRightToLeft":false,"campaign":{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"},"customLanguageItems":[{"campaignId":"9300C9E4-CBDE-4CA9-9611-9A8C254A954E","systemName":"LanguageButtonYes","customText":"Yes","id":"4ABF541C-BD8D-480B-800C-A780D15CE093"}]}
Get campaign languge items

GET livechat/campaigns/{id}/LanguageItems

Parameters:

No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/E024CF39-D62C-454C-AB60-39DD5310C72D/LanguageItems \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"campaignId":"2eeb87ba-95d6-4259-9195-ba71e1061380","isCustomLanguageEnabled":false,"isTextDirectionRightToLeft":false,"languageItems":[{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonYes","siteId":0,"text":"Yes"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonNo","siteId":0,"text":"No"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonClose","siteId":0,"text":"Close"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonCancel","siteId":0,"text":"Cancel"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSave","siteId":0,"text":"Save"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSubmit","siteId":0,"text":"Submit"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSubmitting","siteId":0,"text":"Submitting"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonStartChat","siteId":0,"text":"Start Chatting"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonEndChat","siteId":0,"text":"End Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonTranscript","siteId":0,"text":"Transcript"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonRequestVoice","siteId":0,"text":"Request Voice Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonStopVoice","siteId":0,"text":"Stop Voice Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSend","siteId":0,"text":"Send"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSending","siteId":0,"text":"Sending"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSendFile","siteId":0,"text":"Send File"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSoundOn","siteId":0,"text":"Sound On"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSoundOff","siteId":0,"text":"Sound Off"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonRating","siteId":0,"text":"Rating"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonSetName","siteId":0,"text":"Set Name"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonPrint","siteId":0,"text":"Print"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonLogin","siteId":0,"text":"Login"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonContinueAsVisitor","siteId":0,"text":"Continue as Visitor"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldDepartmentStatusOnline","siteId":0,"text":" (online)"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldDepartmentStatusOffline","siteId":0,"text":" (offline)"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldNoDepartment","siteId":0,"text":"--Choose a department--"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageDropdownListDefault","siteId":0,"text":"--Choose an option--"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePreChatSocialMediaSignInWith","siteId":0,"text":"Sign in with"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePreChatSocialMediaOr","siteId":0,"text":"Or"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptEmail","siteId":0,"text":"Send transcript"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptSendFile","siteId":0,"text":"Send File:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptName","siteId":0,"text":"Name:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptStopChat","siteId":0,"text":"Are you sure you want to stop chatting?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptStopVoice","siteId":0,"text":"Are you sure to stop voice chatting?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptAttachmentSize","siteId":0,"text":"(Max attachment size is {fileSize} MB)"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptSubmitSuccess","siteId":0,"text":"Offline Message submitted successfully."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptInputLimit","siteId":0,"text":"Message cannot exceed 10000 characters."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptRequired","siteId":0,"text":"Required"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptSendFileCountLimit","siteId":0,"text":"Only {fileCount} files are allowed to be transferred in one chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptInvalidEmail","siteId":0,"text":"Email is invalid."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptFieldLengthExceed","siteId":0,"text":"The length of {fieldName} cannot exceed {fieldLength} characters."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptFileSizeExceed","siteId":0,"text":"File size cannot exceed {fileSize} MB."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptBanMessage","siteId":0,"text":"You have been banned!"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptFlashRequired","siteId":0,"text":"To start voice chatting, please make sure that Adobe Flash Player version 10.0.0 or above is installed."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptSSL","siteId":0,"text":"Secure Connection"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptVoiceChatInitFailed","siteId":0,"text":"Initialization failed! Voice chat connection cannot be established."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptServerException","siteId":0,"text":"System Error: {errorCode}."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageErrorVisitorNotExist","siteId":0,"text":"Oops. You have lost the connection to the chat server. Please close the window and try again."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptTicketNotExist","siteId":0,"text":"Ticket {ticketId} does not exist."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptIncorrectVerificationCode","siteId":0,"text":"Incorrent verification code."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptForgetPassword","siteId":0,"text":"Forgot Password"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptRegisterNow","siteId":0,"text":"Register Now"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptPasswordError","siteId":0,"text":"Invalid email or password."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptPressEnterToSend","siteId":0,"text":"Type a message here"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingTitle","siteId":0,"text":"Rating"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingCommentTitle","siteId":0,"text":"Type your comment here"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageStartChatAgain","siteId":0,"text":"Start chat again"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTranslation","siteId":0,"text":"Translation"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageOriginal","siteId":0,"text":"Original"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePromptIfLogin","siteId":0,"text":"Would you like to sign in first?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonLoginAsUser","siteId":0,"text":"Sign In"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonChatAsVisitor","siteId":0,"text":"Not Now"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorDefaultName","siteId":0,"text":"Visitor"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorRequestChat","siteId":0,"text":"Please wait for a site agent to respond..."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorEndChat","siteId":0,"text":"The visitor has left the chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageOperatorDefaultName","siteId":0,"text":"Agent"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorAcceptChat","siteId":0,"text":"Agent {agent} has joined the chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorEndChat","siteId":0,"text":"Agent {agent} has left the chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventSystemEndChat","siteId":0,"text":"The chat is ended."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorJoinChat","siteId":0,"text":"Agent {agent} has joined the chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorTransferChat","siteId":0,"text":"Agent {agent} has transferred the chat to another agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventTransferChatToDepartment","siteId":0,"text":"Transferring to {department}. You can continue to chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorRefuseChat","siteId":0,"text":"Your chat request is declined by Agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorRequestVoice","siteId":0,"text":"Agent {agent} is requesting a voice chat with you. Do you want to accept?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorRefuseVoice","siteId":0,"text":"Agent {agent} has refused the voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorAcceptVoice","siteId":0,"text":"Agent {agent} has accepted the voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorEndVoice","siteId":0,"text":"Agent {agent} has ended the voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorIsTyping","siteId":0,"text":"Agent is typing..."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorIsTyping","siteId":0,"text":"Visitor is typing."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorRequestVoice","siteId":0,"text":"The visitor requests a voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorRefuseVoice","siteId":0,"text":"The visitor has refused the voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorAcceptVoice","siteId":0,"text":"The visitor has accepted the voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorEndVoice","siteId":0,"text":"The visitor has ended the voice chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorSetEmail","siteId":0,"text":"The transcript will be sent to \"{email}\" after the chat ends."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorSetName","siteId":0,"text":"The visitor has set their name to \"{visitor}\"."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventSystemEndVoiceChat","siteId":0,"text":"The voice chat is ended."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorSendFile","siteId":0,"text":"Agent {agent} has sent a file: {file}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorSendFile","siteId":0,"text":"The visitor has sent a file: {file}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorSendImage","siteId":0,"text":"The visitor has sent an image: {image}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorSendImage","siteId":0,"text":"Agent {agent} has sent an image: {image}."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventSendTranscript","siteId":0,"text":"The chat transcript has been sent to \"{email}\"."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventAttachToNewTicket","siteId":0,"text":"Ticket {ticketId} created successfully. The chat transcript will be attached to this ticket after the transcript is saved in the system."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventAttachToExsitTicket","siteId":0,"text":"The chat transcript will be attached to ticket {ticketId} after the chat ends."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventRatingSubmitSuccess","siteId":0,"text":"Rating submitted successfully. Thanks for your support."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorRequestChatInQueue","siteId":0,"text":"You are No.{queuePosition} in the queue. The estimated wait time is about {estimatedWaitTime} minute(s). Thank you for your patience."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorNotRespondAndStopChat","siteId":0,"text":"It’‘s been quite a long time since your last response."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorNotRespondInChat","siteId":0,"text":"It’‘s been a while since your last response. Please respond within the next few minutes or this chat will be ended."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventPromoteToContact","siteId":0,"text":""},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventPromoteToUser","siteId":0,"text":"You have been promoted to a user. Please check your email {email} for your login information."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguagePostChatSuccess","siteId":0,"text":"Post chat survey submitted successfully!"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventLeaveOfflineMessage","siteId":0,"text":"If you do not want to wait, please click {linkText} to leave us a message."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventLinkText","siteId":0,"text":"here"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageOperatorEnableTranslation","siteId":0,"text":"Agent {agent} has turned on Auto Translation."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageOperatorDisableTranslation","siteId":0,"text":"Agent {agent} has turned off Auto Translation."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorRequestSecureForm","siteId":0,"text":"Agent {agent} has requested a form \"{form}\"."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorSubmitSecureForm","siteId":0,"text":"Visitor has submitted the form \"{form}\"."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorCancelSecureForm","siteId":0,"text":"Visitor has cancelled the request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorGetSecureFormFailure","siteId":0,"text":"No form was received by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorCreditCardNumberMasked","siteId":0,"text":"The credit card number in the message has been masked for privacy."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventOperatorIsBusy","siteId":0,"text":"Sorry that I am busy at the moment. Could you please hold on for me? I’‘ll soon be with you. Thank you."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageScreenSharingInvitationMessage","siteId":0,"text":"I’‘ve started a screen sharing meeting. Please click on the following link to join me: {linkText}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageServerJoinMeLink","siteId":0,"text":"I’‘ve started a screen sharing meeting. Please click on the following link to join me:{linkText}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmailChatSubject","siteId":0,"text":"Chat Transcript with {agent}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmailChatOperators","siteId":0,"text":"Agents:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmailChatStartTime","siteId":0,"text":"Start Time:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmailChatEndTime","siteId":0,"text":"End Time:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmailChatTranscript","siteId":0,"text":"Transcripts:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobilePreChat","siteId":0,"text":"Pre-chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileWaiting","siteId":0,"text":"Waiting"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileChatting","siteId":0,"text":"Chatting"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileChatEnded","siteId":0,"text":"Chat Ended"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileOfflineMessage","siteId":0,"text":"Offline message"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileEnterYourEmailHere","siteId":0,"text":"Enter your email here"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileEnterYourNameHere","siteId":0,"text":"Enter your name here"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileInvitationTitle","siteId":0,"text":"Invitation"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileAcceptInvitation","siteId":0,"text":"Chat now"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMobileDeclineInvitation","siteId":0,"text":"No, thanks"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowWaitingForChat","siteId":0,"text":"Waiting for Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowNewMessages","siteId":0,"text":"You have got {count} new messages."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowChattingWithOperator","siteId":0,"text":"Chatting with {agent}"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowChatEnded","siteId":0,"text":"Chat Ended"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowMinimize","siteId":0,"text":"Minimize"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowPopup","siteId":0,"text":"Popup"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldName","siteId":0,"text":"Name"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldCompany","siteId":0,"text":"Company"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldEmail","siteId":0,"text":"Email"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldProduct","siteId":0,"text":"Product Service"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldTitle","siteId":0,"text":"Subject"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldContent","siteId":0,"text":"Message"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldAttachment","siteId":0,"text":"Attachment"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldPhone","siteId":0,"text":"Phone"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingGrade1Text","siteId":0,"text":"Poor"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingGrade2Text","siteId":0,"text":"Fair"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingGrade3Text","siteId":0,"text":"Good"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingGrade4Text","siteId":0,"text":"Very Good"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRatingGrade5Text","siteId":0,"text":"Excellent"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldDepartment","siteId":0,"text":"Department"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldTicketId","siteId":0,"text":"Ticket ID"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldRating","siteId":0,"text":"Rating"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldRatingComment","siteId":0,"text":"Comments"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatButtonMobileOnlineText","siteId":0,"text":"Chat with us"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatButtonMobileOfflineText","siteId":0,"text":"Leave a message"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageGreetingRating","siteId":0,"text":"Please comment on our service performance so that we can serve you better. Thanks for your time!"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageGreetingChatWindow","siteId":0,"text":""},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageInvitationText","siteId":0,"text":"Hello, how may I help you?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldAutoLogin","siteId":0,"text":"Save Password"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldPassword","siteId":0,"text":"Password:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldVerificationCode","siteId":0,"text":"Verification Code"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageLoginWindowGreetingMessage","siteId":0,"text":"Please login before proceeding."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageLoginWindowTitle","siteId":0,"text":"Continue as Visitor"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageFieldLoginEmail","siteId":0,"text":"Email:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTitlePreChatWindow","siteId":0,"text":"Comm100 Live Chat - Pre-Chat Window"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTitleChatWindow","siteId":0,"text":"Comm100 Live Chat - Chat Window"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTitleOfflineMessageWindow","siteId":0,"text":"Comm100 Live Chat - Offline Message Window"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageGreetingOfflineMessageWindow","siteId":0,"text":"Please leave us a message and we will get back to you shortly."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageGreetingPreChatWindow","siteId":0,"text":"Welcome to our website. We are excited to chat with you!"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTextLink","siteId":0,"text":"Chat Now"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonAudioChat","siteId":0,"text":"Audio Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonVideoChat","siteId":0,"text":"Video Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAudioChatCalling","siteId":0,"text":"Audio Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorRequestAudioChat","siteId":0,"text":"The visitor has sent an audio chat request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorCancelAudioChat","siteId":0,"text":"The audio chat request has been cancelled by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorAcceptAudioChat","siteId":0,"text":"The audio chat request has been accepted by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorRefuseAudioChat","siteId":0,"text":"The audio chat request has been declined by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentRequestAudioChat","siteId":0,"text":"The agent has sent an audio chat request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentCancelAudioChat","siteId":0,"text":"The audio chat request has been cancelled by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentAcceptAudioChat","siteId":0,"text":"The audio chat request has been accepted by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentRefuseAudioChat","siteId":0,"text":"The audio chat request has been declined by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAudioChatNoAnswer","siteId":0,"text":"The audio chat request has not been answered."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentInAnotherAudioChat","siteId":0,"text":"The agent is in another audio chat. Please send a text message."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAudioChatEnd","siteId":0,"text":"The audio chat has ended. (Duration {durationTime})"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVideoChatCalling","siteId":0,"text":"Video Chat"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorRequestVideoChat","siteId":0,"text":"The visitor has sent a video chat request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorCancelVideoChat","siteId":0,"text":"The video chat request has been cancelled by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorAcceptVideoChat","siteId":0,"text":"The video chat request has been accepted by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVisitorRefuseVideoChat","siteId":0,"text":"The video chat request has been declined by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentRequestVideoChat","siteId":0,"text":"The agent has sent a video chat request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentCancelVideoChat","siteId":0,"text":"The video chat request has been cancelled by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentAcceptVideoChat","siteId":0,"text":"The video chat request has been accepted by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentRefuseVideoChat","siteId":0,"text":"The video chat request has been declined by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVideoChatNoAnswer","siteId":0,"text":"The video chat request has not been answered."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentInAnotherVideoChat","siteId":0,"text":"The agent is in another video chat. Please send a text message."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVideoChatEnd","siteId":0,"text":"The video chat has ended. (Duration {durationTime})"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonChatbotChatWithAgent","siteId":0,"text":"Chat with Human Agent"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonChatbotHelpful","siteId":0,"text":"Helpful"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonChatbotNotHelpful","siteId":0,"text":"Not Helpful"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotName","siteId":0,"text":"Bot"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotGreetingMessage","siteId":0,"text":"Hi there, this is Chatbot. How may I help you today?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotNoAnswerMessage","siteId":0,"text":"I am afraid that I cannot help you with this."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotNotHelpfulMessage","siteId":0,"text":"I am sorry that this doesn’‘t answer your question."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotPossibleQuestionMessage","siteId":0,"text":"It seems that none of these links answers your question."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotJoinChat","siteId":0,"text":"{Chatbot} has joined the chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotRelatedQuestions","siteId":0,"text":"Related Questions:"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotPossibleAnswer","siteId":0,"text":"I’‘ve got you some relevant questions that may help. Is your question similar to any of the questions below?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotHelpful","siteId":0,"text":"Visitor rated this answer Helpful."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageChatbotNotHelpful","siteId":0,"text":"Visitor rated this answer Not Helpful."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTypeHereChat","siteId":0,"text":"Type and start"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageWriteReply","siteId":0,"text":"Write a reply…"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTeamName","siteId":0,"text":"Our Team"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEmbeddedWindowPopin","siteId":0,"text":"Restore"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonKBChatWithAgent","siteId":0,"text":"Chat with Agent"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonKBLeaveMessage","siteId":0,"text":"Leave a message"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageTypeYourEmailHere","siteId":0,"text":"Type your email here"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseRequest","siteId":0,"text":"The agent has sent a Cobrowsing request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseNoAnswer","siteId":0,"text":"The Cobrowsing request has not been answered."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseCancel","siteId":0,"text":"The Cobrowsing request has been cancelled by the agent."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseRefuse","siteId":0,"text":"The Cobrowsing request has been refused by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseAccept","siteId":0,"text":"The Cobrowsing request has been accepted by the visitor."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseEnd","siteId":0,"text":"The Cobrowsing session has ended. (Duration {durationTime})"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseAgentWait","siteId":0,"text":"Agent {name} is requesting to see your current web pages..."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseNotes","siteId":0,"text":"Agent can only see pages of the current website, not your any other browser tabs, open applications or desktop."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseAllowControl","siteId":0,"text":"Allow the agent to take control?"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageCobrowseStop","siteId":0,"text":"Stop Showing"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageDownloadTranscript","siteId":0,"text":"Download chat transcript"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageEventVisitorCancelBotForm","siteId":0,"text":"Visitor has cancelled the form."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageMsgNotSeenByAgent","siteId":0,"text":"Not seen yet"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageRecaptchaError","siteId":0,"text":"The Captcha field is required. If it is not loaded, please try again with another browser."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAgentSendSSOSignIn","siteId":0,"text":"Agent {agent} has sent a sign-in request."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAudioVideoChangeWindowType","siteId":0,"text":"If you change the chat window type now, your current audio/video call will be ended right away. Your live chat will continue in the new window where you can also start a new audio/video chat."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageButtonContinue","siteId":0,"text":"Continue"},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAudioChatWillBeRecorded","siteId":0,"text":"Your audio chat will be recorded."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageAudioChatBeingRecorded","siteId":0,"text":"The audio chat is being recorded."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVideoChatWillBeRecorded","siteId":0,"text":"Your video chat will be recorded."},{"campaignId":"00000000-0000-0000-0000-000000000000","systemName":"LanguageVideoChatBeingRecorded","siteId":0,"text":"The video chat is being recorded."}]}
Update the Language

PUT livechat/campaigns/{id}/languageConfig

Parameters:
Name Type In Required Description
isCustomLanguageEnabled bool body no Whether the campaign used custom language or not.
isTextDirectionRightToLeft bool body no Whether the campaign's custom language text directed from right to left or not.
customLanguageItems customLanguageItems[] body no Reference to Custom Language.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/languageConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isCustomLanguageEnabled":false,"isTextDirectionRightToLeft":false,"customLanguageItems":[{"systemName":"LanguageButtonYes","customText":"Yes"}]}'

Response:

 HTTP/1.1 200 OK

{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","isCustomLanguageEnabled":false,"isTextDirectionRightToLeft":false,"campaign":{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"},"customLanguageItems":[{"campaignId":"9300C9E4-CBDE-4CA9-9611-9A8C254A954E","systemName":"LanguageButtonYes","customText":"Yes","id":"4ABF541C-BD8D-480B-800C-A780D15CE093"}]}