Campaign

Campaign

You need the Manage Campaigns permission to manage Campaign.

• Campaigns - Campaigns Manage

  • GET livechat/campaigns - Get the list of Campaigns
  • GET livechat/campaigns/{id} - Get a single Campaign
  • POST livechat/campaigns - Create a new Campaign
  • PUT livechat/campaigns/{id} - Update the Campaign
  • DELETE livechat/campaigns/{id} - Remove the Campaign

• Chat Buttons - Chat Buttons Manage

  • GET livechat/campaigns/{id}/chatButton - Get a single Chat Button
  • PUT livechat/campaigns/{id}/chatButton - Update the Chat Button

• Chat Button Gallery Images - Chat Button Gallery Images Manage

  • GET livechat/chatButtonGalleryImages - Get the list of Chat Button Gallery Images
  • GET livechat/chatButtonGalleryImages/{id} - Get a single Chat Button Gallery Image

• Chat Windows - Chat Windows Manage

  • GET livechat/campaigns/{id}/chatWindow - Get a single Chat Window
  • PUT livechat/campaigns/{id}/chatWindow - Update the Chat Window

• Chat Window Banner Gallery Images - Chat Window Banner Gallery Images Manage

  • GET livechat/chatWindowBannerGalleryImages - Get the list of Chat Window Banner Gallery Images
  • GET livechat/chatWindowBannerGalleryImages/{id} - [Get a single Chat Window Banner Gallery Image](

  -banner-gallery-image)

• Chat Window Logo Gallery Images - Chat Window Logo Gallery Images Manage

  • GET livechat/chatWindowLogoGalleryImages - Get the list of Chat Window Logo Gallery Images
  • GET livechat/chatWindowLogoGalleryImages/{id} - Get a single Chat Window Logo Gallery Image

• Pre-chat - Pre-chat Manage

  • GET livechat/campaigns/{id}/preChat - Get a single Pre-chat
  • POST livechat/campaigns/{id}/preChat:disable - Disable the Pre-chat
  • POST livechat/campaigns/{id}/preChat:enable - Enable the Pre-chat
  • PUT livechat/campaigns/{id}/preChat - Update the Pre-chat

• Pre-chat Form Fields - Pre-chat Form Fields Manage

  • GET livechat/preChatFormFields - Get the list of Pre-chat Form Fields
  • GET livechat/preChatFormFields/{id} - Get a single Pre-chat Form Field

• Canned Messages - Canned Messages Manage

  • GET livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig - Get a single Canned Message
  • POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:disable - Disable the Canned Message
  • POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:enable - Enable the Canned Message
  • PUT livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig - Update the Canned Message

• Offline Messages - Offline Messages Manage

  • GET livechat/campaigns/{id}/offlineMessageConfig - Get a single Offline Message
  • PUT livechat/campaigns/{id}/offlineMessageConfig - Update the Offline Message

• Offline Message Form Fields - Offline Message Form Fields Manage

  • GET livechat/offlineMessageFormFields - Get the list of Offline Message Form Fields
  • GET livechat/offlineMessageFormFields/{id} - Get a single Offline Message Form Field

• Post-chats - Post-chats Manage

  • GET livechat/campaigns/{id}/postChat - Get a single Post-chat
  • POST livechat/campaigns/{id}/postChat:disable - Disable the Post-chat
  • POST livechat/campaigns/{id}/postChat:enable - Enable the Post-chat
  • PUT livechat/campaigns/{id}/postChat - Update the Post-chat

• Post Chat Form Fields - Post Chat Form Fields Manage

  • GET livechat/postChatFormFields - Get the list of Post Chat Form Fields
  • GET livechat/postChatFormFields/{id} - Get a single Post Chat Form Field

• Rating Grades - Rating Grades Manage

  • GET livechat/ratingGrades - Get the list of Rating Grades
  • GET livechat/ratingGrades/{id} - Get a single Rating Grade
  • PUT livechat/ratingGrades/{id} - Update the Rating Grade

• KB Integration - KB Integration Manage

  • GET livechat/campaigns/{id}/integrationKbConfig - Get a single KB Integration
  • PUT livechat/campaigns/{id}/integrationKbConfig - Update the KB Integration

• Routing Rules - Routing Rules Manage

  • GET livechat/campaigns/{id}/routingConfig - Get a single Routing Rule
  • PUT livechat/campaigns/{id}/routingConfig - Update the Routing Rule

• Rules - Rules Manage

  • POST livechat/routingRules/{id}:disable - Disable the Rule
  • POST livechat/routingRules/{id}:enable - Enable the Rule

• AI Chatbot - AI Chatbot Manage

  • GET livechat/campaigns/{id}/integrationChatBotConfig - Get a single AI Chatbot
  • PUT livechat/campaigns/{id}/integrationChatBotConfig - Update the AI Chatbot

• Manual Invitations - Manual Invitations Manage

  • GET livechat/campaigns/{id}/manualInvitation - Get a single Manual Invitation
  • PUT livechat/campaigns/{id}/manualInvitation - Update the Manual Invitation

• Languages - Languages Manage

  • GET livechat/campaigns/{id}/languageConfig - Get a single Language
  • GET livechat/campaigns/{id}/LanguageItems - Get campaign language items
  • PUT livechat/campaigns/{id}/languageConfig - Update the Language

Campaign JSON Format

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

Routing Rule Condition JSON Format:

Custom Language JSON Format:

Get the list of Campaigns

GET livechat/campaigns

• Parameters:

• Response:

An array of Campaign

• Example

Sample Request:

curl https://api11.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:

• Response:

Campaign

• Example

Sample Request:

curl https://api11.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:

• Response:

Campaign

• Example

Sample Request:

curl https://api11.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"}' 

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:

• Response:

Campaign

• Example

Sample Request:

curl https://api11.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"}'

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://api11.comm100.io/v4/livechat/campaigns/E7B4BD07-C09D-4252-856E-49CA22537B94 \ 
    -X 'DELETE' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 204 No Content

Chat Button JSON Format

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

Get a single Chat Button

GET livechat/campaigns/{id}/chatButton

• Parameters:

No Parameters

• Response:

Chat Button

• Example

Sample Request:

curl https://api11.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://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImage",
  "imageButtonOfflineImage": "https://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOfflineImage",
  "imageButtonTypeOnMobile": "text",
  "imageButtonColorOnMobile": "#222222",
  "imageButtonTextColorOnMobile": "#ffffff",
  "imageButtonOnlineImageOnMobile": "https://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImageOnMobile",
  "imageButtonOfflineImageOnMobile": "https://api11.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://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/customizedAdaptiveButtonImage",
  "builtinImageChatButtonImage": {
      "id": "A56CFF58-C148-EB11-8100-00155D081D0B",
      "themeColor": 1,
      "onlineImage": "https://api11.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage",
      "offlineImage": "https://api11.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:

• Response:

Chat Button

• Example

Sample Request:

curl https://api11.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","imageButtonXOffset":0,"isImageButtonXOffsetByPixel":false,"imageButtonYOffset":0,"isImageButtonYOffsetByPixel":false,"imageButtonImageSource":"fromGallery","builtinImageChatButtonImageId":"9DAE5329-7C46-EB11-8100-00155D081D0B","imageButtonOnlineImage":"https://api11.comm100.io/LiveChat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/chatButton/imageButtonOnlineImage?SiteId=10000&version=c5ee5b32b5fd67ce03027da05506f121","imageButtonOfflineImage":"https://api11.comm100.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://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImage",
  "imageButtonOfflineImage": "https://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOfflineImage",
  "imageButtonTypeOnMobile": "text",
  "imageButtonColorOnMobile": "#222222",
  "imageButtonTextColorOnMobile": "#ffffff",
  "imageButtonOnlineImageOnMobile": "https://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/imageButtonOnlineImageOnMobile",
  "imageButtonOfflineImageOnMobile": "https://api11.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://api11.comm100.io/v4/LiveChat/chatButtons/8FAE5329-7C46-EB11-8100-00155D081D0B/customizedAdaptiveButtonImage",
  "builtinImageChatButtonImage": {
      "id": "A56CFF58-C148-EB11-8100-00155D081D0B",
      "themeColor": 1,
      "onlineImage": "https://api11.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage",
      "offlineImage": "https://api11.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/offlineImage",
      "language": "turkish",
      "order": 1,
      "isVisible": true
  }
} 

Chat Button Gallery Image JSON Format

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

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://api11.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://api11.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage",
      "offlineImage": "https://api11.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:

Chat Button Gallery Image

• Example

Sample Request:

curl https://api11.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://api11.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/onlineImage",
  "offlineImage": "https://api11.comm100.io/v4/LiveChat/chatButtonGalleryImages/A56CFF58-C148-EB11-8100-00155D081D0B/offlineImage",
  "language": "turkish",
  "order": 1,
  "isVisible": true
} 

Chat Window JSON Format

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

Get a single Chat Window

GET livechat/campaigns/{id}/chatWindow

• Parameters:

No Parameters

• Response:

Chat Window

• Example

Sample Request:

curl https://api11.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://api11.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customLogoImage",
  "customBannerImage": "https://api11.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customBannerImage",
  "isAvatarDisplayedWithMessage": true,
  "isBackgroundDisplayed": true,
  "backgroundTexture": "style1",
  "customCSSOfClassic": ".window--classic .window__headerBox {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-box-align: center;\n  -ms-flex-align: center;\n  align-items: center;\n}\n.window--classic .header__bannerImg {\n  display: block;\n  max-width: calc(100% + 54px);\n  margin: 0 -27px -23px;\n}\n.window--classic .header__avatar {\n  float: left;\n  margin-right: 17px;\n  width: 45px;\n  height: 45px;\n  -ms-flex-item-align: start;\n  align-self: flex-start;\n}\n.window--classic .header__avatarImage {\n  display: block;\n  border-radius: 100%;\n  width: 45px;\n  height: 45px;\n}\n.window--classic .header__agent {\n  -webkit-box-align: center;\n  -ms-flex-align: center;\n  align-items: center;\n  max-width: 100%;\n  -webkit-box-flex: 0;\n  -ms-flex-positive: 0;\n  flex-grow: 0;\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n}\n.window--classic .header__agentName {\n  font-size: 1.133333rem;\n  line-height: 1.29;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n}\n.window--classic .header__agentTitle {\n  font-size: 0.8rem;\n  line-height: 1.25;\n  opacity: 0.5;\n  overflow: hidden;\n  white-space: nowrap;\n  text-overflow: ellipsis;\n}\n.window--classic .header__agentBio {\n  font-size: 0.8rem;\n  line-height: 1.17;\n  opacity: 0.8;\n  margin-top: 4px;\n  padding-left: 60px;\n  padding-bottom: 2px;\n  margin-bottom: -2px;\n  max-height: 84px;\n  overflow-y: auto;\n}\n.window--classic .header__logo {\n  margin-left: auto;\n  margin-top: 9px;\n  margin-bottom: 5px;\n}\n.window--classic .header__logoImg {\n  max-height: 45px;\n  max-width: 100px;\n  display: block;\n  float: right;\n  width: auto;\n  height: auto;\n}\n.window--classic .header__teamName {\n  font-size: 1.133333rem;\n  line-height: 1.29;\n  text-align: center;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n  width: 100%;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  margin-bottom: 8px;\n}\n.window--classic .header__teamAvatar {\n  position: relative;\n  width: 142px;\n  height: 40px;\n  margin: 9px auto;\n}\n.window--classic .header__teamAvatarImg {\n  position: absolute;\n  width: 40px;\n  height: 40px;\n  border-radius: 100%;\n}\n.window--classic .header__teamAvatarImg:nth-child(1) {\n  left: 0;\n  z-index: 9;\n}\n.window--classic .header__teamAvatarImg:nth-child(2) {\n  left: 49px;\n  z-index: 8;\n}\n.window--classic .header__teamAvatarImg:nth-child(3) {\n  left: 99px;\n  z-index: 7;\n}\n.window__chatSystemMessage {\n  font-size: 1rem;\n  text-align: center;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  word-wrap: break-word;\n}\n.window__chatAgent,\n.window__chatVisitor {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  position: relative;\n}\n.window__chatVisitor {\n  -webkit-box-orient: horizontal;\n  -webkit-box-direction: reverse;\n  -ms-flex-direction: row-reverse;\n  flex-direction: row-reverse;\n}\n.window__chatAgentMessage,\n.window__chatVisitorMessage {\n  position: relative;\n  font-size: 0.93333333rem;\n  line-height: 1.57;\n  padding: 17px 22px 19px;\n  word-wrap: break-word;\n  word-break: break-word;\n  border-radius: 5px;\n}\n.window__chatVisitorMessage {\n  margin-left: 67px;\n  max-width: calc(100% - 67px);\n  background-color: #329fd9;\n  border-bottom-right-radius: 0;\n}\n.window__chatAgentMessage {\n  border-bottom-left-radius: 0;\n  background: #f5f7f9;\n}\n.chat-time {\n  opacity: 0;\n  font-size: 0.8rem;\n  background: rgba(0, 0, 0, 0.6);\n  padding: 0 5px;\n  line-height: 17px;\n  height: 17px;\n  border-radius: 8px;\n  transition: opacity 50ms linear;\n  position: absolute;\n  z-index: 1;\n}\n.chat-input__controlbox {\n  padding: 10px 10px 10px 0;\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n}\n.window__chatSender {\n  position: absolute;\n  right: 26px;\n  bottom: 16px;\n  width: 20px;\n  height: 20px;\n  border: none;\n  background: 0 0;\n  -webkit-animation: fadeIn 0.5s;\n  animation: fadeIn 0.5s;\n}\n.footer {\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n  z-index: 999;\n  width: 100%;\n  padding-left: 15px;\n  padding-right: 15px;\n  font-size: 0.8rem;\n  height: 23px;\n  background: 0 0;\n  border-radius: 0 0 5px 5px;\n}\nbody,\nhtml {\n  margin: 0;\n}\nhtml {\n  position: fixed;\n  left: 0;\n  right: 0;\n  top: 0;\n  bottom: 0;\n  font-size: 15px;\n  -webkit-text-size-adjust: 100%;\n}\nbody {\n  font-family: \"SourceSans Pro\", Arial;\n  line-height: 1.42857143;\n  overflow: hidden;\n}",
  "customCSSOfCircle": ".window--circle .header__bannerImg {\n  display: block;\n  max-width: calc(100% + 40px);\n  margin: 0 0 -15px -20px;\n}\n.window--circle .header__avatar {\n  position: absolute;\n  top: -69.5px;\n  left: 50%;\n  margin-left: -35px;\n}\n.window--circle .header__avatarImage {\n  display: block;\n  border-radius: 100%;\n  width: 65px;\n  height: 65px;\n  margin: 0 auto;\n}\n.window--circle .header__agentName {\n  max-width: calc(100% - 90px);\n  margin: 0 auto;\n  font-size: 1.13333333rem;\n  line-height: 1.29;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n}\n.window--circle .header__agentTitle {\n  font-size: 0.8rem;\n  margin-top: 2px;\n  line-height: 1.25;\n  opacity: 0.5;\n}\n.window--circle .header__agentBio {\n  text-align: center;\n  margin-top: 2px;\n  margin-bottom: 1px;\n  padding-bottom: 2px;\n  font-size: 0.8rem;\n  line-height: 1.17;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: -webkit-box;\n  max-height: 70px;\n  -webkit-line-clamp: 4;\n  -webkit-box-orient: vertical;\n  width: 100%;\n  opacity: 0.8;\n  overflow-y: auto;\n}\n.window--circle .header__teamName {\n  font-size: 1.133333333333333rem;\n  line-height: 1.29;\n  margin-top: 21px;\n  text-align: center;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n}\n.window--circle .header__teamAvatar {\n  position: absolute;\n  left: 50%;\n  top: -22px;\n  width: 112px;\n  height: 42px;\n  margin-bottom: 10px;\n  margin-left: -56px;\n  -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\n    both;\n  animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\n  -webkit-animation-delay: 0.3s;\n  animation-delay: 0.3s;\n}\n.window--circle .header__teamAvatarImg {\n  position: absolute;\n  width: 44px;\n  height: 44px;\n  border: 2px solid #fff;\n  border-radius: 100%;\n  top: 0;\n}\n.window--circle .header__teamAvatarImg:nth-child(1) {\n  z-index: 8;\n}\n.window--circle .header__teamAvatarImg:nth-child(2) {\n  left: 36px;\n  z-index: 9;\n}\n.window--circle .header__teamAvatarImg:nth-child(3) {\n  right: 0;\n  z-index: 10;\n}\n.window--circle .window__headerBox {\n  border-bottom: 1px solid #ddd;\n  width: calc(100% - 40px);\n  margin: 0 auto;\n  padding-left: 0;\n  padding-right: 0;\n  padding-bottom: 15px;\n}\n.window__chatSystemMessage {\n  font-size: 1rem;\n  text-align: center;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  word-wrap: break-word;\n}\n.window__chatAgent,\n.window__chatVisitor {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  position: relative;\n}\n.window__chatVisitor {\n  -webkit-box-orient: horizontal;\n  -webkit-box-direction: reverse;\n  -ms-flex-direction: row-reverse;\n  flex-direction: row-reverse;\n}\n.window__chatAgentMessage,\n.window__chatVisitorMessage {\n  position: relative;\n  font-size: 0.93333333rem;\n  line-height: 1.57;\n  padding: 17px 22px 19px;\n  word-wrap: break-word;\n  word-break: break-word;\n  border-radius: 5px;\n}\n.window__chatVisitorMessage {\n  margin-left: 67px;\n  max-width: calc(100% - 67px);\n  background-color: #329fd9;\n  border-bottom-right-radius: 0;\n}\n.window__chatAgentMessage {\n  border-bottom-left-radius: 0;\n  background: #f5f7f9;\n}\n.chat-time {\n  opacity: 0;\n  font-size: 0.8rem;\n  background: rgba(0, 0, 0, 0.6);\n  padding: 0 5px;\n  line-height: 17px;\n  height: 17px;\n  border-radius: 8px;\n  transition: opacity 50ms linear;\n  position: absolute;\n  z-index: 1;\n}\n.chat-input__controlbox {\n  padding: 10px 10px 10px 0;\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n}\n.window__chatSender {\n  position: absolute;\n  right: 26px;\n  bottom: 16px;\n  width: 20px;\n  height: 20px;\n  border: none;\n  background: 0 0;\n  -webkit-animation: fadeIn 0.5s;\n  animation: fadeIn 0.5s;\n}\n.footer {\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n  z-index: 999;\n  width: 100%;\n  padding-left: 15px;\n  padding-right: 15px;\n  font-size: 0.8rem;\n  height: 23px;\n  background: 0 0;\n  border-radius: 0 0 5px 5px;\n}\nbody,\nhtml {\n  margin: 0;\n}\nhtml {\n  position: fixed;\n  left: 0;\n  right: 0;\n  top: 0;\n  bottom: 0;\n  font-size: 15px;\n  -webkit-text-size-adjust: 100%;\n}\nbody {\n  font-family: \"SourceSans Pro\", Arial;\n  line-height: 1.42857143;\n  overflow: hidden;\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,
  "ifAllowToRequestScreenSharing": false,
  "isBrowserPopupNotificationEnabled": false,
  "ifEndChatWhenVisitorIsInactive": true,
  "minutesOfVisitorInactivity": 15,
  "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) });\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://api11.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage",
      "order": 1,
      "isVisible": true
  },
  "builtinChatWindowLogo": {
      "id": "B86CFF58-C148-EB11-8100-00155D081D0B",
      "logoImage": "https://api11.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage",
      "order": 1
  }
} 

Update the Chat Window

PUT livechat/campaigns/{id}/chatWindow

• Parameters:

• Response:

Chat Window

• Example

Sample Request:

curl https://api11.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 {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-box-align: center;\n  -ms-flex-align: center;\n  align-items: center;\n}\n.window--classic .header__bannerImg {\n  display: block;\n  max-width: calc(100% + 54px);\n  margin: 0 -27px -23px;\n}\n.window--classic .header__avatar {\n  float: left;\n  margin-right: 17px;\n  width: 45px;\n  height: 45px;\n  -ms-flex-item-align: start;\n  align-self: flex-start;\n}\n.window--classic .header__avatarImage {\n  display: block;\n  border-radius: 100%;\n  width: 45px;\n  height: 45px;\n}\n.window--classic .header__agent {\n  -webkit-box-align: center;\n  -ms-flex-align: center;\n  align-items: center;\n  max-width: 100%;\n  -webkit-box-flex: 0;\n  -ms-flex-positive: 0;\n  flex-grow: 0;\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n}\n.window--classic .header__agentName {\n  font-size: 1.133333rem;\n  line-height: 1.29;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n}\n.window--classic .header__agentTitle {\n  font-size: 0.8rem;\n  line-height: 1.25;\n  opacity: 0.5;\n  overflow: hidden;\n  white-space: nowrap;\n  text-overflow: ellipsis;\n}\n.window--classic .header__agentBio {\n  font-size: 0.8rem;\n  line-height: 1.17;\n  opacity: 0.8;\n  margin-top: 4px;\n  padding-left: 60px;\n  padding-bottom: 2px;\n  margin-bottom: -2px;\n  max-height: 84px;\n  overflow-y: auto;\n}\n.window--classic .header__logo {\n  margin-left: auto;\n  margin-top: 9px;\n  margin-bottom: 5px;\n}\n.window--classic .header__logoImg {\n  max-height: 45px;\n  max-width: 100px;\n  display: block;\n  float: right;\n  width: auto;\n  height: auto;\n}\n.window--classic .header__teamName {\n  font-size: 1.133333rem;\n  line-height: 1.29;\n  text-align: center;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n  width: 100%;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  margin-bottom: 8px;\n}\n.window--classic .header__teamAvatar {\n  position: relative;\n  width: 142px;\n  height: 40px;\n  margin: 9px auto;\n}\n.window--classic .header__teamAvatarImg {\n  position: absolute;\n  width: 40px;\n  height: 40px;\n  border-radius: 100%;\n}\n.window--classic .header__teamAvatarImg:nth-child(1) {\n  left: 0;\n  z-index: 9;\n}\n.window--classic .header__teamAvatarImg:nth-child(2) {\n  left: 49px;\n  z-index: 8;\n}\n.window--classic .header__teamAvatarImg:nth-child(3) {\n  left: 99px;\n  z-index: 7;\n}\n.window__chatSystemMessage {\n  font-size: 1rem;\n  text-align: center;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  word-wrap: break-word;\n}\n.window__chatAgent,\n.window__chatVisitor {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  position: relative;\n}\n.window__chatVisitor {\n  -webkit-box-orient: horizontal;\n  -webkit-box-direction: reverse;\n  -ms-flex-direction: row-reverse;\n  flex-direction: row-reverse;\n}\n.window__chatAgentMessage,\n.window__chatVisitorMessage {\n  position: relative;\n  font-size: 0.93333333rem;\n  line-height: 1.57;\n  padding: 17px 22px 19px;\n  word-wrap: break-word;\n  word-break: break-word;\n  border-radius: 5px;\n}\n.window__chatVisitorMessage {\n  margin-left: 67px;\n  max-width: calc(100% - 67px);\n  background-color: #329fd9;\n  border-bottom-right-radius: 0;\n}\n.window__chatAgentMessage {\n  border-bottom-left-radius: 0;\n  background: #f5f7f9;\n}\n.chat-time {\n  opacity: 0;\n  font-size: 0.8rem;\n  background: rgba(0, 0, 0, 0.6);\n  padding: 0 5px;\n  line-height: 17px;\n  height: 17px;\n  border-radius: 8px;\n  transition: opacity 50ms linear;\n  position: absolute;\n  z-index: 1;\n}\n.chat-input__controlbox {\n  padding: 10px 10px 10px 0;\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n}\n.window__chatSender {\n  position: absolute;\n  right: 26px;\n  bottom: 16px;\n  width: 20px;\n  height: 20px;\n  border: none;\n  background: 0 0;\n  -webkit-animation: fadeIn 0.5s;\n  animation: fadeIn 0.5s;\n}\n.footer {\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n  z-index: 999;\n  width: 100%;\n  padding-left: 15px;\n  padding-right: 15px;\n  font-size: 0.8rem;\n  height: 23px;\n  background: 0 0;\n  border-radius: 0 0 5px 5px;\n}\nbody,\nhtml {\n  margin: 0;\n}\nhtml {\n  position: fixed;\n  left: 0;\n  right: 0;\n  top: 0;\n  bottom: 0;\n  font-size: 15px;\n  -webkit-text-size-adjust: 100%;\n}\nbody {\n  font-family: \"SourceSans Pro\", Arial;\n  line-height: 1.42857143;\n  overflow: hidden;\n}","customCSSOfCircle":".window--circle .header__bannerImg {\n  display: block;\n  max-width: calc(100% + 40px);\n  margin: 0 0 -15px -20px;\n}\n.window--circle .header__avatar {\n  position: absolute;\n  top: -69.5px;\n  left: 50%;\n  margin-left: -35px;\n}\n.window--circle .header__avatarImage {\n  display: block;\n  border-radius: 100%;\n  width: 65px;\n  height: 65px;\n  margin: 0 auto;\n}\n.window--circle .header__agentName {\n  max-width: calc(100% - 90px);\n  margin: 0 auto;\n  font-size: 1.13333333rem;\n  line-height: 1.29;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n}\n.window--circle .header__agentTitle {\n  font-size: 0.8rem;\n  margin-top: 2px;\n  line-height: 1.25;\n  opacity: 0.5;\n}\n.window--circle .header__agentBio {\n  text-align: center;\n  margin-top: 2px;\n  margin-bottom: 1px;\n  padding-bottom: 2px;\n  font-size: 0.8rem;\n  line-height: 1.17;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: -webkit-box;\n  max-height: 70px;\n  -webkit-line-clamp: 4;\n  -webkit-box-orient: vertical;\n  width: 100%;\n  opacity: 0.8;\n  overflow-y: auto;\n}\n.window--circle .header__teamName {\n  font-size: 1.133333333333333rem;\n  line-height: 1.29;\n  margin-top: 21px;\n  text-align: center;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n}\n.window--circle .header__teamAvatar {\n  position: absolute;\n  left: 50%;\n  top: -22px;\n  width: 112px;\n  height: 42px;\n  margin-bottom: 10px;\n  margin-left: -56px;\n  -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\n    both;\n  animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\n  -webkit-animation-delay: 0.3s;\n  animation-delay: 0.3s;\n}\n.window--circle .header__teamAvatarImg {\n  position: absolute;\n  width: 44px;\n  height: 44px;\n  border: 2px solid #fff;\n  border-radius: 100%;\n  top: 0;\n}\n.window--circle .header__teamAvatarImg:nth-child(1) {\n  z-index: 8;\n}\n.window--circle .header__teamAvatarImg:nth-child(2) {\n  left: 36px;\n  z-index: 9;\n}\n.window--circle .header__teamAvatarImg:nth-child(3) {\n  right: 0;\n  z-index: 10;\n}\n.window--circle .window__headerBox {\n  border-bottom: 1px solid #ddd;\n  width: calc(100% - 40px);\n  margin: 0 auto;\n  padding-left: 0;\n  padding-right: 0;\n  padding-bottom: 15px;\n}\n.window__chatSystemMessage {\n  font-size: 1rem;\n  text-align: center;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  word-wrap: break-word;\n}\n.window__chatAgent,\n.window__chatVisitor {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  position: relative;\n}\n.window__chatVisitor {\n  -webkit-box-orient: horizontal;\n  -webkit-box-direction: reverse;\n  -ms-flex-direction: row-reverse;\n  flex-direction: row-reverse;\n}\n.window__chatAgentMessage,\n.window__chatVisitorMessage {\n  position: relative;\n  font-size: 0.93333333rem;\n  line-height: 1.57;\n  padding: 17px 22px 19px;\n  word-wrap: break-word;\n  word-break: break-word;\n  border-radius: 5px;\n}\n.window__chatVisitorMessage {\n  margin-left: 67px;\n  max-width: calc(100% - 67px);\n  background-color: #329fd9;\n  border-bottom-right-radius: 0;\n}\n.window__chatAgentMessage {\n  border-bottom-left-radius: 0;\n  background: #f5f7f9;\n}\n.chat-time {\n  opacity: 0;\n  font-size: 0.8rem;\n  background: rgba(0, 0, 0, 0.6);\n  padding: 0 5px;\n  line-height: 17px;\n  height: 17px;\n  border-radius: 8px;\n  transition: opacity 50ms linear;\n  position: absolute;\n  z-index: 1;\n}\n.chat-input__controlbox {\n  padding: 10px 10px 10px 0;\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n}\n.window__chatSender {\n  position: absolute;\n  right: 26px;\n  bottom: 16px;\n  width: 20px;\n  height: 20px;\n  border: none;\n  background: 0 0;\n  -webkit-animation: fadeIn 0.5s;\n  animation: fadeIn 0.5s;\n}\n.footer {\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n  z-index: 999;\n  width: 100%;\n  padding-left: 15px;\n  padding-right: 15px;\n  font-size: 0.8rem;\n  height: 23px;\n  background: 0 0;\n  border-radius: 0 0 5px 5px;\n}\nbody,\nhtml {\n  margin: 0;\n}\nhtml {\n  position: fixed;\n  left: 0;\n  right: 0;\n  top: 0;\n  bottom: 0;\n  font-size: 15px;\n  -webkit-text-size-adjust: 100%;\n}\nbody {\n  font-family: \"SourceSans Pro\", Arial;\n  line-height: 1.42857143;\n  overflow: hidden;\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,"ifAllowToRequestScreenSharing":false,"isBrowserPopupNotificationEnabled":false,"ifEndChatWhenVisitorIsInactive":true,"minutesOfVisitorInactivity":15,"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) });\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://api11.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customLogoImage",
  "customBannerImage": "https://api11.comm100.io/v4/LiveChat/chatWindows/27792c81-38d2-4398-ba40-bafc804ffd2d/customBannerImage",
  "isAvatarDisplayedWithMessage": true,
  "isBackgroundDisplayed": true,
  "backgroundTexture": "style1",
  "customCSSOfClassic": ".window--classic .window__headerBox {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-box-align: center;\n  -ms-flex-align: center;\n  align-items: center;\n}\n.window--classic .header__bannerImg {\n  display: block;\n  max-width: calc(100% + 54px);\n  margin: 0 -27px -23px;\n}\n.window--classic .header__avatar {\n  float: left;\n  margin-right: 17px;\n  width: 45px;\n  height: 45px;\n  -ms-flex-item-align: start;\n  align-self: flex-start;\n}\n.window--classic .header__avatarImage {\n  display: block;\n  border-radius: 100%;\n  width: 45px;\n  height: 45px;\n}\n.window--classic .header__agent {\n  -webkit-box-align: center;\n  -ms-flex-align: center;\n  align-items: center;\n  max-width: 100%;\n  -webkit-box-flex: 0;\n  -ms-flex-positive: 0;\n  flex-grow: 0;\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n}\n.window--classic .header__agentName {\n  font-size: 1.133333rem;\n  line-height: 1.29;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n}\n.window--classic .header__agentTitle {\n  font-size: 0.8rem;\n  line-height: 1.25;\n  opacity: 0.5;\n  overflow: hidden;\n  white-space: nowrap;\n  text-overflow: ellipsis;\n}\n.window--classic .header__agentBio {\n  font-size: 0.8rem;\n  line-height: 1.17;\n  opacity: 0.8;\n  margin-top: 4px;\n  padding-left: 60px;\n  padding-bottom: 2px;\n  margin-bottom: -2px;\n  max-height: 84px;\n  overflow-y: auto;\n}\n.window--classic .header__logo {\n  margin-left: auto;\n  margin-top: 9px;\n  margin-bottom: 5px;\n}\n.window--classic .header__logoImg {\n  max-height: 45px;\n  max-width: 100px;\n  display: block;\n  float: right;\n  width: auto;\n  height: auto;\n}\n.window--classic .header__teamName {\n  font-size: 1.133333rem;\n  line-height: 1.29;\n  text-align: center;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n  width: 100%;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  margin-bottom: 8px;\n}\n.window--classic .header__teamAvatar {\n  position: relative;\n  width: 142px;\n  height: 40px;\n  margin: 9px auto;\n}\n.window--classic .header__teamAvatarImg {\n  position: absolute;\n  width: 40px;\n  height: 40px;\n  border-radius: 100%;\n}\n.window--classic .header__teamAvatarImg:nth-child(1) {\n  left: 0;\n  z-index: 9;\n}\n.window--classic .header__teamAvatarImg:nth-child(2) {\n  left: 49px;\n  z-index: 8;\n}\n.window--classic .header__teamAvatarImg:nth-child(3) {\n  left: 99px;\n  z-index: 7;\n}\n.window__chatSystemMessage {\n  font-size: 1rem;\n  text-align: center;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  word-wrap: break-word;\n}\n.window__chatAgent,\n.window__chatVisitor {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  position: relative;\n}\n.window__chatVisitor {\n  -webkit-box-orient: horizontal;\n  -webkit-box-direction: reverse;\n  -ms-flex-direction: row-reverse;\n  flex-direction: row-reverse;\n}\n.window__chatAgentMessage,\n.window__chatVisitorMessage {\n  position: relative;\n  font-size: 0.93333333rem;\n  line-height: 1.57;\n  padding: 17px 22px 19px;\n  word-wrap: break-word;\n  word-break: break-word;\n  border-radius: 5px;\n}\n.window__chatVisitorMessage {\n  margin-left: 67px;\n  max-width: calc(100% - 67px);\n  background-color: #329fd9;\n  border-bottom-right-radius: 0;\n}\n.window__chatAgentMessage {\n  border-bottom-left-radius: 0;\n  background: #f5f7f9;\n}\n.chat-time {\n  opacity: 0;\n  font-size: 0.8rem;\n  background: rgba(0, 0, 0, 0.6);\n  padding: 0 5px;\n  line-height: 17px;\n  height: 17px;\n  border-radius: 8px;\n  transition: opacity 50ms linear;\n  position: absolute;\n  z-index: 1;\n}\n.chat-input__controlbox {\n  padding: 10px 10px 10px 0;\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n}\n.window__chatSender {\n  position: absolute;\n  right: 26px;\n  bottom: 16px;\n  width: 20px;\n  height: 20px;\n  border: none;\n  background: 0 0;\n  -webkit-animation: fadeIn 0.5s;\n  animation: fadeIn 0.5s;\n}\n.footer {\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n  z-index: 999;\n  width: 100%;\n  padding-left: 15px;\n  padding-right: 15px;\n  font-size: 0.8rem;\n  height: 23px;\n  background: 0 0;\n  border-radius: 0 0 5px 5px;\n}\nbody,\nhtml {\n  margin: 0;\n}\nhtml {\n  position: fixed;\n  left: 0;\n  right: 0;\n  top: 0;\n  bottom: 0;\n  font-size: 15px;\n  -webkit-text-size-adjust: 100%;\n}\nbody {\n  font-family: \"SourceSans Pro\", Arial;\n  line-height: 1.42857143;\n  overflow: hidden;\n}",
  "customCSSOfCircle": ".window--circle .header__bannerImg {\n  display: block;\n  max-width: calc(100% + 40px);\n  margin: 0 0 -15px -20px;\n}\n.window--circle .header__avatar {\n  position: absolute;\n  top: -69.5px;\n  left: 50%;\n  margin-left: -35px;\n}\n.window--circle .header__avatarImage {\n  display: block;\n  border-radius: 100%;\n  width: 65px;\n  height: 65px;\n  margin: 0 auto;\n}\n.window--circle .header__agentName {\n  max-width: calc(100% - 90px);\n  margin: 0 auto;\n  font-size: 1.13333333rem;\n  line-height: 1.29;\n  text-shadow: 0 1px 0 rgba(0, 0, 0, 0.2);\n}\n.window--circle .header__agentTitle {\n  font-size: 0.8rem;\n  margin-top: 2px;\n  line-height: 1.25;\n  opacity: 0.5;\n}\n.window--circle .header__agentBio {\n  text-align: center;\n  margin-top: 2px;\n  margin-bottom: 1px;\n  padding-bottom: 2px;\n  font-size: 0.8rem;\n  line-height: 1.17;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: -webkit-box;\n  max-height: 70px;\n  -webkit-line-clamp: 4;\n  -webkit-box-orient: vertical;\n  width: 100%;\n  opacity: 0.8;\n  overflow-y: auto;\n}\n.window--circle .header__teamName {\n  font-size: 1.133333333333333rem;\n  line-height: 1.29;\n  margin-top: 21px;\n  text-align: center;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n}\n.window--circle .header__teamAvatar {\n  position: absolute;\n  left: 50%;\n  top: -22px;\n  width: 112px;\n  height: 42px;\n  margin-bottom: 10px;\n  margin-left: -56px;\n  -webkit-animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86)\n    both;\n  animation: fadeInDown 292ms cubic-bezier(0.785, 0.135, 0.15, 0.86) both;\n  -webkit-animation-delay: 0.3s;\n  animation-delay: 0.3s;\n}\n.window--circle .header__teamAvatarImg {\n  position: absolute;\n  width: 44px;\n  height: 44px;\n  border: 2px solid #fff;\n  border-radius: 100%;\n  top: 0;\n}\n.window--circle .header__teamAvatarImg:nth-child(1) {\n  z-index: 8;\n}\n.window--circle .header__teamAvatarImg:nth-child(2) {\n  left: 36px;\n  z-index: 9;\n}\n.window--circle .header__teamAvatarImg:nth-child(3) {\n  right: 0;\n  z-index: 10;\n}\n.window--circle .window__headerBox {\n  border-bottom: 1px solid #ddd;\n  width: calc(100% - 40px);\n  margin: 0 auto;\n  padding-left: 0;\n  padding-right: 0;\n  padding-bottom: 15px;\n}\n.window__chatSystemMessage {\n  font-size: 1rem;\n  text-align: center;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  word-wrap: break-word;\n}\n.window__chatAgent,\n.window__chatVisitor {\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n  -webkit-animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  animation: message--show 458ms cubic-bezier(0.785, 0.135, 0.15, 0.86);\n  position: relative;\n}\n.window__chatVisitor {\n  -webkit-box-orient: horizontal;\n  -webkit-box-direction: reverse;\n  -ms-flex-direction: row-reverse;\n  flex-direction: row-reverse;\n}\n.window__chatAgentMessage,\n.window__chatVisitorMessage {\n  position: relative;\n  font-size: 0.93333333rem;\n  line-height: 1.57;\n  padding: 17px 22px 19px;\n  word-wrap: break-word;\n  word-break: break-word;\n  border-radius: 5px;\n}\n.window__chatVisitorMessage {\n  margin-left: 67px;\n  max-width: calc(100% - 67px);\n  background-color: #329fd9;\n  border-bottom-right-radius: 0;\n}\n.window__chatAgentMessage {\n  border-bottom-left-radius: 0;\n  background: #f5f7f9;\n}\n.chat-time {\n  opacity: 0;\n  font-size: 0.8rem;\n  background: rgba(0, 0, 0, 0.6);\n  padding: 0 5px;\n  line-height: 17px;\n  height: 17px;\n  border-radius: 8px;\n  transition: opacity 50ms linear;\n  position: absolute;\n  z-index: 1;\n}\n.chat-input__controlbox {\n  padding: 10px 10px 10px 0;\n  display: -webkit-box;\n  display: -ms-flexbox;\n  display: flex;\n}\n.window__chatSender {\n  position: absolute;\n  right: 26px;\n  bottom: 16px;\n  width: 20px;\n  height: 20px;\n  border: none;\n  background: 0 0;\n  -webkit-animation: fadeIn 0.5s;\n  animation: fadeIn 0.5s;\n}\n.footer {\n  -ms-flex-negative: 0;\n  flex-shrink: 0;\n  z-index: 999;\n  width: 100%;\n  padding-left: 15px;\n  padding-right: 15px;\n  font-size: 0.8rem;\n  height: 23px;\n  background: 0 0;\n  border-radius: 0 0 5px 5px;\n}\nbody,\nhtml {\n  margin: 0;\n}\nhtml {\n  position: fixed;\n  left: 0;\n  right: 0;\n  top: 0;\n  bottom: 0;\n  font-size: 15px;\n  -webkit-text-size-adjust: 100%;\n}\nbody {\n  font-family: \"SourceSans Pro\", Arial;\n  line-height: 1.42857143;\n  overflow: hidden;\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,
  "ifAllowToRequestScreenSharing": false,
  "isBrowserPopupNotificationEnabled": false,
  "ifEndChatWhenVisitorIsInactive": true,
  "minutesOfVisitorInactivity": 15,
  "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) });\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://api11.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage",
      "order": 1,
      "isVisible": true
  },
  "builtinChatWindowLogo": {
      "id": "B86CFF58-C148-EB11-8100-00155D081D0B",
      "logoImage": "https://api11.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage",
      "order": 1
  }
} 

Chat Window Banner Gallery Image JSON Format

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

Get the list of Chat Window Banner Gallery Images

GET livechat/chatWindowBannerGalleryImages

• Parameters:

No Parameters

• Response:

An array of Chat Window Banner Gallery Image

• Example

Sample Request:

curl https://api11.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://api11.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:

Chat Window Banner Gallery Image

• Example

Sample Request:

curl https://api11.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://api11.comm100.io/v4/LiveChat/chatWindowBannerGalleryImages/AB6CFF58-C148-EB11-8100-00155D081D0B/bannerImage",
  "order": 1,
  "isVisible": true
} 

Chat Window Logo Gallery Image JSON Format

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

Get the list of Chat Window Logo Gallery Images

GET livechat/chatWindowLogoGalleryImages

• Parameters:

No Parameters

• Response:

An array of Chat Window Logo Gallery Image

• Example

Sample Request:

curl https://api11.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://api11.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:

Chat Window Logo Gallery Image

• Example

Sample Request:

curl https://api11.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://api11.comm100.io/v4/LiveChat/chatWindowLogoGalleryImages/B86CFF58-C148-EB11-8100-00155D081D0B/logoImage",
  "order": 1
} 

Pre-chat JSON Format

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

Get a single Pre-chat

GET livechat/campaigns/{id}/preChat

• Parameters:

No Parameters

• Response:

Pre-chat

• Example

Sample Request:

curl https://api11.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:

Pre-chat

• Example

Sample Request:

curl https://api11.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:

Pre-chat

• Example

Sample Request:

curl https://api11.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:

• Response:

Pre-chat

• Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/campaigns/22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef/preChat \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"type": "form","isTeamNameDisplayed": true,"displayTeamName": "Our Team","isAgentAvatarDisplayed": true,"popUpPreChatTitle": "Comm100 Live Chat - Pre-Chat Window","greetingMessage": "<p>Welcome to our website. We are excited to chat with you</p>","facebookLogin": false,"preChatFormFields": [{"id": "1c156a5e-909e-473c-af87-67287fc6ae08","campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91","fieldId": "ec505148-5e65-442d-81ee-63f379d0227a","label": "Name","isVisible": true,"isRequired": true,"order": 1,"field": {"id": "ec505148-5e65-442d-81ee-63f379d0227a","isSystem": true,"name": "Name","type": "text","leftText": "","rightText": "","fieldOptions": []}}],"isGoogleReCaptchaEnabled": true,"captchaLabelText": "Captcha","isVisitorInfoRecorded": true,"formFieldLayoutStyle": "aboveInput","taskbotId": "23d88cd2-75ca-47d4-b8d1-0c250bb14691","isInputAreaEnabledWhenUsedInPreChat": true,"campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91","isEnabled": true}' 

Response:

HTTP/1.1 200 OK

{
  "campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91",
  "isEnabled": true,
  "isTeamNameDisplayed": true,
  "displayTeamName": "Our Team",
  "isAgentAvatarDisplayed": true,
  "popUpPreChatTitle": "Comm100 Live Chat - Pre-Chat Window",
  "greetingMessage": "<p>Welcome to our website. We are excited to chat with you</p>",
  "facebookLogin": false,
  "isVisitorInfoRecorded": true,
  "isGoogleReCaptchaEnabled": true,
  "captchaLabelText": "Captcha",
  "formFieldLayoutStyle": "aboveInput",
  "type": "form",
  "isInputAreaEnabledWhenUsedInPreChat": true,
  "taskbotId": "23d88cd2-75ca-47d4-b8d1-0c250bb14691",
  "preChatFormFields": [
      {
          "id": "1c156a5e-909e-473c-af87-67287fc6ae08",
          "campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91",
          "fieldId": "ec505148-5e65-442d-81ee-63f379d0227a",
          "label": "Name",
          "isVisible": true,
          "isRequired": true,
          "order": 1,
          "field": {
              "id": "ec505148-5e65-442d-81ee-63f379d0227a",
              "isSystem": true,
              "name": "Name",
              "type": "text",
              "leftText": "",
              "rightText": "",
              "fieldOptions": []
          }
      }
  ]
}

Pre-chat Form Field JSON Format

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

Get the list of Pre-chat Form Fields

GET livechat/preChatFormFields

• Parameters:

• Response:

An array of Pre-chat Form Field

• Example

Sample Request:

curl https://api11.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:

Pre-chat Form Field

• Example

Sample Request:

curl https://api11.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
          }
      ]
  }
} 

Canned Message JSON Format

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

Get a single Canned Message

GET livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig

• Parameters:

No Parameters

• Response:

Canned Message

• Example

Sample Request:

curl https://api11.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:

Canned Message

• Example

Sample Request:

curl https://api11.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:

Canned Message

• Example

Sample Request:

curl https://api11.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:

• Response:

Canned Message

• Example

Sample Request:

curl https://api11.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"
  ]
} 

Offline Message JSON Format

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

Get a single Offline Message

GET livechat/campaigns/{id}/offlineMessageConfig

• Parameters:

No Parameters

• Response:

Offline Message

• Example

Sample Request:

curl https://api11.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:

• Response:

Offline Message

• Example

Sample Request:

curl https://api11.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","isTeamNameDisplayed": true,"displayTeamName": "Our Team","isAgentAvatarDisplayed": true,"popUpOfflineMessageTitle": "Comm100 Live Chat - Offline Message Window","greetingMessage": "<p>Please leave us a message and we will get back to you shortly.2</p>","offlineMessageFormFields": [{"id": "d2b15ee1-d8ed-4807-b1b2-166eb45c35a3","campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91","fieldId": "b250c882-40fe-402a-b3d1-4f1b7071c811","label": "Attachment","isVisible": false,"isRequired": false,"order": 9,"field": {"id": "b250c882-40fe-402a-b3d1-4f1b7071c811","isSystem": true,"name": "Attachment","type": "attachment","leftText": "","rightText": "","fieldOptions": []}}],"emailOfflineMessageTo": "allAgent","customEmailAddresses": "","formFieldLayoutStyle": "aboveInput","customOfflineMessagePageURL": "","ifOpenCustomOfflineMessagePageInNewWindow": true,"taskbotId": "00000000-0000-0000-0000-000000000000","isInputAreaEnabledWhenUsedInOfflineMessage": false,"campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91"}' 

Response:

HTTP/1.1 200 OK

{
  "campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91",
  "type": "systemOfflineMessageWindow",
  "customOfflineMessagePageURL": "",
  "ifOpenCustomOfflineMessagePageInNewWindow": true,
  "isTeamNameDisplayed": true,
  "displayTeamName": "Our Team",
  "isAgentAvatarDisplayed": true,
  "popUpOfflineMessageTitle": "Comm100 Live Chat - Offline Message Window",
  "greetingMessage": "<p>Please leave us a message and we will get back to you shortly.2</p>",
  "emailOfflineMessageTo": "allAgent",
  "customEmailAddresses": "",
  "formFieldLayoutStyle": "aboveInput",
  "taskbotId": "00000000-0000-0000-0000-000000000000",
  "isInputAreaEnabledWhenUsedInOfflineMessage": false,
  "offlineMessageFormFields": [
      {
          "id": "d2b15ee1-d8ed-4807-b1b2-166eb45c35a3",
          "campaignId": "87441e0b-056f-4008-b455-b6e1e9098c91",
          "fieldId": "b250c882-40fe-402a-b3d1-4f1b7071c811",
          "label": "Attachment",
          "isVisible": false,
          "isRequired": false,
          "order": 9,
          "field": {
              "id": "b250c882-40fe-402a-b3d1-4f1b7071c811",
              "isSystem": true,
              "name": "Attachment",
              "type": "attachment",
              "leftText": "",
              "rightText": "",
              "fieldOptions": []
          }
      }
  ]
}

Offline Message Form Field JSON Format

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

Get the list of Offline Message Form Fields

GET livechat/offlineMessageFormFields

• Parameters:

No Parameters

• Response:

An array of Offline Message Form Field

• Example

Sample Request:

curl https://api11.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:

Offline Message Form Field

• Example

Sample Request:

curl https://api11.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
          }
      ]
  }
} 

Post-chat JSON Format

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

Get a single Post-chat

GET livechat/campaigns/{id}/postChat

• Parameters:

No Parameters

• Response:

Post-chat

• Example

Sample Request:

curl https://api11.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": "Scale 1",
                  "label": "Excellent",
                  "isVisible": true
              }
          ]
      }
  ]
} 

Disable the Post-chat

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

• Parameters:

No Parameters

• Response:

Post-chat

• Example

Sample Request:

curl https://api11.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": "Scale 1",
                  "label": "Excellent",
                  "isVisible": true
              }
          ]
      }
  ]
} 

Enable the Post-chat

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

• Parameters:

No Parameters

• Response:

Post-chat

• Example

Sample Request:

curl https://api11.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": "Scale 1",
                  "label": "Excellent",
                  "isVisible": true
              }
          ]
      }
  ]
} 

Update the Post-chat

PUT livechat/campaigns/{id}/postChat

• Parameters:

• Response:

Post-chat

• Example

Sample Request:

curl https://api11.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":"Scale 1","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": "Scale 1",
                  "label": "Excellent",
                  "isVisible": true
              }
          ]
      }
  ]
} 

Post Chat Form Field JSON Format

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

Get the list of Post Chat Form Fields

GET livechat/postChatFormFields

• Parameters:

No Parameters

• Response:

An array of Post Chat Form Field

• Example

Sample Request:

curl https://api11.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": "Scale 1",
              "label": "Excellent",
              "isVisible": true
          }
      ]
  }
] 

Get a single Post Chat Form Field

GET livechat/postChatFormFields/{id}

• Parameters:

No Parameters

• Response:

Post Chat Form Field

• Example

Sample Request:

curl https://api11.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": "Scale 1",
          "label": "Excellent",
          "isVisible": true
      }
  ]
} 

Rating Grade JSON Format

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

Get the list of Rating Grades

GET livechat/ratingGrades

• Parameters:

No Parameters

• Response:

An array of Rating Grade

• Example

Sample Request:

curl https://api11.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": "Scale 1",
      "label": "Excellent",
      "isVisible": true
  }
] 

Get a single Rating Grade

GET livechat/ratingGrades/{id}

• Parameters:

No Parameters

• Response:

Rating Grade

• Example

Sample Request:

curl https://api11.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": "Scale 1",
  "label": "Excellent",
  "isVisible": true
} 

Update the Rating Grade

PUT livechat/ratingGrades/{id}

• Parameters:

• Response:

Rating Grade

• Example

Sample Request:

curl https://api11.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":"Scale 1","label":"Excellent","isVisible":true}' 

Response:

HTTP/1.1 200 OK

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

KB Integration JSON Format

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

Get a single KB Integration

GET livechat/campaigns/{id}/integrationKbConfig

• Parameters:

• Response:

KB Integration

• Example

Sample Request:

curl https://api11.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:

• Response:

KB Integration

• Example

Sample Request:

curl https://api11.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"
} 

Routing Rule JSON Format

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

Get a single Routing Rule

GET livechat/campaigns/{id}/routingConfig

• Parameters:

No Parameters

• Response:

Routing Rule

• Example

Sample Request:

curl https://api11.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",
  "noRuleMatchedRouteToDepartmentId": "00000000-0000-0000-0000-000000000000",
  "routeToSkillInDepartmentWhenNoRuleMatchedId": "00000000-0000-0000-0000-000000000000",
  "simpleRouteToSkillInDepartmentId": "00000000-0000-0000-0000-000000000000",
  "routeToSkillInDepartmentWhenNoRuleMatchedId": "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",
          "simpleRouteToSkillInDepartmentId": "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": "c2c165b7-d5ce-40e5-a492-f586f514a062",
              "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.comm100.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111",
              "systemAvatarId": "1383d4fd-3114-eb11-80fc-00155d081d0b",
              "avatar": "https://api11.comm100.io/v4/Global/agents/c2c165b7-d5ce-40e5-a492-f586f514a062/avatar",
              "permissionIds": [
                  "45A2EF45-7D46-EB11-8100-00155D081D0B"
              ],
              "departmentIds": [
                  "b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"
              ],
              "roleIds": [
                  "e0bf1302-d145-eb11-8100-00155d081d0b"
              ]
          },
          "routeToDepartment": {
              "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095",
              "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:

• Response:

Routing Rule

• Example

Sample Request:

curl https://api11.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","simpleRouteToSkillInDepartmentId":"00000000-0000-0000-0000-000000000000","noRuleMatchedRouteToDepartmentId":"00000000-0000-0000-0000-000000000000","routeToSkillInDepartmentWhenNoRuleMatchedId": "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","simpleRouteToSkillInDepartmentId": "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",
  "simpleRouteToSkillInDepartmentId":"00000000-0000-0000-0000-000000000000",
  "noRuleMatchedRouteToDepartmentId": "00000000-0000-0000-0000-000000000000",
  "routeToSkillInDepartmentWhenNoRuleMatchedId": "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",
          "simpleRouteToSkillInDepartmentId": "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": "c2c165b7-d5ce-40e5-a492-f586f514a062",
              "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.comm100.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111",
              "systemAvatarId": "1383d4fd-3114-eb11-80fc-00155d081d0b",
              "avatar": "https://api11.comm100.io/v4/Global/agents/c2c165b7-d5ce-40e5-a492-f586f514a062/avatar",
              "permissionIds": [
                  "45A2EF45-7D46-EB11-8100-00155D081D0B"
              ],
              "departmentIds": [
                  "b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"
              ],
              "roleIds": [
                  "e0bf1302-d145-eb11-8100-00155d081d0b"
              ]
          },
          "routeToDepartment": {
              "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095",
              "name": "markting",
              "description": "markting departments",
              "isAvailableInLiveChat": true,
              "isAvailableInTicketingAndMessaging": true,
              "offlineMessageMailTo": "toAllAgents",
              "offlineMessageEmailAddresses": "andy@comm100.com",
              "agentIds": [
                  "b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"
              ]
          }
      }
  ]
} 

Rule JSON Format

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

Disable the Rule

POST livechat/routingRules/{id}:disable

• Parameters:

No Parameters

• Response:

Rule

• Example

Sample Request:

curl https://api11.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": "c2c165b7-d5ce-40e5-a492-f586f514a062",
      "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.comm100.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111",
      "systemAvatarId": "1383d4fd-3114-eb11-80fc-00155d081d0b",
      "avatar": "https://api11.comm100.io/v4/Global/agents/c2c165b7-d5ce-40e5-a492-f586f514a062/avatar",
      "permissionIds": [
          "45A2EF45-7D46-EB11-8100-00155D081D0B"
      ],
      "departmentIds": [
          "b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"
      ],
      "roleIds": [
          "e0bf1302-d145-eb11-8100-00155d081d0b"
      ]
  },
  "routeToDepartment": {
      "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095",
      "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:

Rule

• Example

Sample Request:

curl https://api11.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": "c2c165b7-d5ce-40e5-a492-f586f514a062",
      "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.comm100.io/Global/agents/c1ad60f8-e2e1-47d2-ad50-8b5de24d2b06/customizeAvatar?SiteId=10000&version=6e7b513d20baaf89b84e81e56d365111",
      "systemAvatarId": "1383d4fd-3114-eb11-80fc-00155d081d0b",
      "avatar": "https://api11.comm100.io/v4/Global/agents/c2c165b7-d5ce-40e5-a492-f586f514a062/avatar",
      "permissionIds": [
          "45A2EF45-7D46-EB11-8100-00155D081D0B"
      ],
      "departmentIds": [
          "b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"
      ],
      "roleIds": [
          "e0bf1302-d145-eb11-8100-00155d081d0b"
      ]
  },
  "routeToDepartment": {
      "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095",
      "name": "markting",
      "description": "markting departments",
      "isAvailableInLiveChat": true,
      "isAvailableInTicketingAndMessaging": true,
      "offlineMessageMailTo": "toAllAgents",
      "offlineMessageEmailAddresses": "andy@comm100.com",
      "agentIds": [
          "b6ff11d8-0be7-4e99-b8c7-5a7ab501c69b"
      ]
  }
} 

AI Chatbot JSON Format

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

Get a single AI Chatbot

GET livechat/campaigns/{id}/integrationChatBotConfig

• Parameters:

• Response:

AI Chatbot

• Example

Sample Request:

curl https://api11.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:

• Response:

AI Chatbot

• Example

Sample Request:

curl https://api11.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
} 

Manual Invitation JSON Format

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

Get a single Manual Invitation

GET livechat/campaigns/{id}/manualInvitation

• Parameters:

No Parameters

• Response:

Manual Invitation

• Example

Sample Request:

curl https://api11.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:

• Response:

Manual Invitation

• Example

Sample Request:

curl https://api11.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?"
} 

Language JSON Format

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

Get a single Language

GET livechat/campaigns/{id}/languageConfig

• Parameters:

No Parameters

• Response:

Language

• Example

Sample Request:

curl https://api11.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",
          "siteId":0,
          "customText": "Yes",
          "IsDeleted": false,
          "id": "00000000-0000-0000-0000-000000000000"
      }
  ]
} 

Get campaign language items

GET livechat/campaigns/{id}/LanguageItems

• Parameters:

No Parameters

• Response:

Language

• Example

Sample Request:

curl https://api11.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:

• Response:

Language

• Example

Sample Request:

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

Response:

HTTP/1.1 200 OK

{
  "campaignId": "22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef",
  "isCustomLanguageEnabled": true,
  "isTextDirectionRightToLeft": false,
  "LanguageItems": [
      {
          "campaignId": "9300C9E4-CBDE-4CA9-9611-9A8C254A954E",
          "systemName": "LanguageButtonYes",
          "siteId": 0,
          "text": "Yes",
      }
  ]
}