You need the Manage Campaigns permission to manage Campaign.
Campaign is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
name |
string | Name of this campaign. |
id |
guid | Id of the campaign. |
description |
string | Description of this campaign. |
language |
string | Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek". |
Routing Rule Condition JSON Format:
Name | Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
guid | Id of the rule condition. | ||||||||||||||||||||||||||||||||||
routingRuleId |
guid | Id of the rule. | ||||||||||||||||||||||||||||||||||
fieldName |
string |
Name of the field.
|
||||||||||||||||||||||||||||||||||
operator |
string | Allowed values are "is", "contains", "notContains", "isMoreThan", "isLessThan", "isNot", "isNotLessThan", "isNotMoreThan", "regularExpression", "isOneOf", "isNotIn", "dateNotEqualTo", "before", "after", "dateEqualTo". | ||||||||||||||||||||||||||||||||||
value |
string | Value of the condition. | ||||||||||||||||||||||||||||||||||
order |
integer | Order of the condition. | ||||||||||||||||||||||||||||||||||
description |
string | Description of the condition. |
Custom Language JSON Format:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
systemName |
string | Name of the custom language. |
customText |
string | Custom test of the custom language. |
id |
guid | Id of the custom language. |
GET livechat/campaigns
Name | Type | In | Required | Description |
---|---|---|---|---|
keywords |
string | query | no | Allowed values are "name","description" |
include |
string | query | no | Allowed values are "campaignChatButton", "campaignChatWindow", "campaignPreChat", "campaignPostChat", "campaignAutoInvitation", "campaignCannedMessageConfig", "campaignOfflineMessage", "wrapupFormField", "integrationKbConfig", "campaignRoutingConfig", "integrationChatBotConfig", "campaignManualInvitation", "campaignLanguageConfig". |
An array of Campaign
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/campaigns/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "campaignChatButton", "campaignChatWindow", "campaignPreChat", "campaignPostChat", "campaignAutoInvitation", "campaignCannedMessageConfig", "campaignOfflineMessage", "wrapupFormField", "integrationKbConfig", "campaignRoutingConfig", "integrationChatBotConfig", "campaignManualInvitation", "campaignLanguageConfig". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | yes | Name of this campaign. |
description |
string | body | no | Description of this campaign. |
language |
string | body | yes | Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek". |
chatButton |
chatButton | body | no | Reference to Chat Button. |
chatWindow |
chatWindow | body | no | Reference to Chat Window. |
preChat |
preChat | body | no | Reference to Pre-chat. |
autoInvitations |
autoInvitations[] | body | no | Reference to LiveChat_CampaignAutoInvitation. |
campaignLinkingToCannedMessageCategoriesConfig |
campaignLinkingToCannedMessageCategoriesConfig | body | no | Reference to Canned Message. |
offlineMessageConfig |
offlineMessageConfig | body | no | Reference to Offline Message. |
postChat |
postChat | body | no | Reference to Post-chat. |
wrapupFormFields |
wrapupFormFields[] | body | no | Reference to LiveChat_Wrap-Up Field. |
integrationKbConfig |
integrationKbConfig | body | no | Reference to KB Integration. |
routingConfig |
routingConfig | body | no | Reference to Routing Rule. |
integrationChatBotConfig |
integrationChatBotConfig | body | no | Reference to AI Chatbot. |
manualInvitation |
manualInvitation | body | no | Reference to LiveChat_CampaignManualInvitation. |
languageConfig |
languageConfig | body | no | Reference to Language. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT livechat/campaigns/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | yes | Name of this campaign. |
description |
string | body | no | Description of this campaign. |
language |
string | body | yes | Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek". |
chatButton |
chatButton | body | no | Reference to Chat Button. |
chatWindow |
chatWindow | body | no | Reference to Chat Window. |
preChat |
preChat | body | no | Reference to Pre-chat. |
autoInvitations |
autoInvitations[] | body | no | Reference to LiveChat_CampaignAutoInvitation. |
campaignLinkingToCannedMessageCategoriesConfig |
campaignLinkingToCannedMessageCategoriesConfig | body | no | Reference to Canned Message. |
offlineMessageConfig |
offlineMessageConfig | body | no | Reference to Offline Message. |
postChat |
postChat | body | no | Reference to Post-chat. |
wrapupFormFields |
wrapupFormFields[] | body | no | Reference to LiveChat_Wrap-Up Field. |
integrationKbConfig |
integrationKbConfig | body | no | Reference to KB Integration. |
routingConfig |
routingConfig | body | no | Reference to Routing Rule. |
integrationChatBotConfig |
integrationChatBotConfig | body | no | Reference to AI Chatbot. |
manualInvitation |
manualInvitation | body | no | Reference to LiveChat_CampaignManualInvitation. |
languageConfig |
languageConfig | body | no | Reference to Language. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE livechat/campaigns/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content
Chat Button is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
type |
string | Allowed values are "adaptive", "image", "textLink". |
isHiddenWhenOffline |
bool | Whether the chat button is visible when no agent is online or not. |
isDomainRestrictionEnabled |
bool | Whether the domain restriction is enabled or not. |
allowedDomains |
string [] | An array of domains or urls, on which the chat button is visible. |
adaptiveButtonColor |
string | The theme color of the chat button. Available when type is adaptive. |
isImageButtonFloating |
bool | Whether the image button is float or not. Available when type is image. |
imageButtonPosition |
string | Allowed values are "centered", "topLeft", "topMiddle", "topRight", "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle". |
imageButtonXOffset |
integer | If isImageButtonXOffsetByPixel is true, it represents the offset pixel value of the X coordinate. If isImageButtonXOffsetByPixel is false, it represents the offset percentage value of the X coordinate. Available when type is image. |
isImageButtonXOffsetByPixel |
bool | Whether represents the offset pixel value of the X coordinate or not. Available when type is image. |
imageButtonYOffset |
integer | If isImageButtonYOffsetByPixel is true, it represents the offset pixel value of the Y coordinate. If isImageButtonYOffsetByPixel is false, it represents the offset percentage value of the Y coordinate. Available when type is image. |
isImageButtonYOffsetByPixel |
bool | Whether represents the offset pixel value of the Y coordinate or not. Available when type is image. |
imageButtonImageSource |
string | Allowed values are "fromGallery", "fromMyComputer". |
builtinImageChatButtonImageId |
guid | Id of the system chat button image. |
imageButtonTypeOnMobile |
string | Allowed values are "text", "image". |
imageButtonColorOnMobile |
string | Image button color on mobile device. |
imageButtonTextColorOnMobile |
string | The theme color of the chat button on mobile device. |
imageButtonPositionOnMobile |
string | Allowed values are "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle", "leftBottom", "rightBottom". |
textLinkButtonText |
string | The content of the text link. Available when type is textLink. |
adaptiveButtonRightOffset |
integer | Offset from right: XX pixels. |
adaptiveButtonBottomOffset |
integer | Offset from bottom: XX pixels. |
adaptiveButtonRightOffsetOnMobile |
integer | Offset from right on mobile device: XX pixels.. |
adaptiveButtonBottomOffsetOnMobile |
integer | Offset from bottom on mobile device: XX pixels.. |
imageButtonOnlineTextOnMobile |
string | The content of the online text link on mobile device, available when imageButtonTypeOnMobile is text. |
imageButtonOfflineTextOnMobile |
string | The content of the offline text link on mobile device, available when imageButtonTypeOnMobile is text. |
customizedAdaptiveButtonImageSource |
string | Allowed values are "fromGallery", "fromMyComputer". |
imageButtonOnlineImage |
string | Image file key of online button, available when type is image. |
imageButtonOfflineImage |
string | Image file key of offline button, available when type is image. |
imageButtonOnlineImageOnMobile |
string | The image file key on mobile device when any agents is online. |
imageButtonOfflineImageOnMobile |
string | The image file key on mobile device when no agents is online. |
customizedAdaptiveButtonImage |
string | The image file key of customized adaptive button image, available when type is adaptive. |
builtinImageChatButtonImage |
builtinImageChatButtonImage | Reference to Chat Button Gallery Image. |
GET livechat/campaigns/{id}/chatButton
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "chatButtonGalleryImage". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/chatButton
Name | Type | In | Required | Description |
---|---|---|---|---|
type |
string | body | no | Allowed values are "adaptive", "image", "textLink". |
isHiddenWhenOffline |
bool | body | yes | Whether the chat button is visible when no agent is online or not. |
isDomainRestrictionEnabled |
bool | body | yes | Whether the domain restriction is enabled or not. |
allowedDomains |
string [] | body | yes | An array of domains or urls, on which the chat button is visible. |
adaptiveButtonColor |
string | body | no | The theme color of the chat button. Available when type is adaptive. |
isImageButtonFloating |
bool | body | yes | Whether the image button is float or not. Available when type is image. |
imageButtonPosition |
string | body | yes | Allowed values are "centered", "topLeft", "topMiddle", "topRight", "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle". |
imageButtonPositionMode |
string | body | no | Allowed values are "basic", "advanced". |
imageButtonXOffset |
integer | body | yes | If isImageButtonXOffsetByPixel is true, it represents the offset pixel value of the X coordinate. If isImageButtonXOffsetByPixel is false, it represents the offset percentage value of the X coordinate. Available when type is image. |
isImageButtonXOffsetByPixel |
bool | body | yes | Whether represents the offset pixel value of the X coordinate or not. Available when type is image. |
imageButtonYOffset |
integer | body | yes | If isImageButtonYOffsetByPixel is true, it represents the offset pixel value of the Y coordinate. If isImageButtonYOffsetByPixel is false, it represents the offset percentage value of the Y coordinate. Available when type is image. |
isImageButtonYOffsetByPixel |
bool | body | yes | Whether represents the offset pixel value of the Y coordinate or not. Available when type is image. |
imageButtonImageSource |
string | body | yes | Allowed values are "fromGallery", "fromMyComputer". |
builtinImageChatButtonImageId |
guid | body | yes | Id of the system chat button image. |
imageButtonTypeOnMobile |
string | body | yes | Allowed values are "text", "image". |
imageButtonColorOnMobile |
string | body | no | Image button color on mobile device. |
imageButtonTextColorOnMobile |
string | body | yes | The theme color of the chat button on mobile device. |
imageButtonPositionOnMobile |
string | body | yes | Allowed values are "bottomLeft", "bottomMiddle", "bottomRight", "leftMiddle", "rightMiddle", "leftBottom", "rightBottom". |
textLinkButtonText |
string | body | no | The content of the text link. Available when type is textLink. |
adaptiveButtonRightOffset |
integer | body | yes | Offset from right: XX pixels. |
adaptiveButtonBottomOffset |
integer | body | yes | Offset from bottom: XX pixels. |
adaptiveButtonRightOffsetOnMobile |
integer | body | yes | Offset from right on mobile device: XX pixels.. |
adaptiveButtonBottomOffsetOnMobile |
integer | body | yes | Offset from bottom on mobile device: XX pixels.. |
imageButtonOnlineTextOnMobile |
string | body | no | The content of the online text link on mobile device, available when imageButtonTypeOnMobile is text. |
imageButtonOfflineTextOnMobile |
string | body | no | The content of the offline text link on mobile device, available when imageButtonTypeOnMobile is text. |
customizedAdaptiveButtonImageSource |
string | body | no | Allowed values are "fromGallery", "fromMyComputer". |
imageButtonOnlineImage |
string | body | no | Image file key of online button, available when type is image. |
imageButtonOfflineImage |
string | body | no | Image file key of offline button, available when type is image. |
imageButtonOnlineImageOnMobile |
string | body | no | The image file key on mobile device when any agents is online. |
imageButtonOfflineImageOnMobile |
string | body | no | The image file key on mobile device when no agents is online. |
customizedAdaptiveButtonImage |
string | body | no | The image file key of customized adaptive button image, available when type is adaptive. |
Sample Request:
Response:
HTTP/1.1 200 OK
Chat Button Gallery Image is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the chat button gallery image. |
themeColor |
integer | Allowed values are "0", "1", "2", "3", "4","5","6". |
language |
string | Allowed values are "english", "simplifiedChinese", "spanish", "japanese", "french", "german", "portuguese", "russian", "dutch", "bulgarian", "italian", "turkish", "greek". |
order |
integer | Order of the chat button gallery image. |
isVisible |
bool | Whether the chat button gallery image is visibled or not. |
onlineImage |
string | Image file key of online button, available when type is image. |
offlineImage |
string | Image file key of offline button, available when type is image. |
GET livechat/chatButtonGalleryImages
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/chatButtonGalleryImages/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
Chat Window is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign which the chat window belongs to. |
style |
string | Allowed values are "classic", "circle", "bubble". |
color |
string | Color of the chat window. |
type |
string | Allowed values are "embeddedChatWindow", "popupChatWindow". |
classicStyleHeaderType |
string | Allowed values are "agent", "banner", "logo". |
isAvatarDisplayed |
bool | Whether the avatar of the agent is displayed or not, available when headerType is agentInfo or avatarAndLogo. |
isTitleDisplayed |
bool | Whether the title of the agent is displayed or not, available when headerType is agentInfo. |
isBioDisplayed |
bool | Whether the bio of the agent is displayed or not, available when headerType is agentInfo. |
isLogoDisplayed |
bool | Whether the logo is displayed or not, available when headerType is avatarAndLogo. |
isAvatarDisplayedWithMessage |
bool | Whether the avatar of the agent is display or not in the message body, available when style is classic or simple. |
isBackgroundDisplayed |
bool | Whether the texture and picture of the background is display or not in the message body, available when style is classic or simple. |
backgroundTexture |
string | Allowed values are "style1", "style2", "style3", "style4", "style5". |
customCSSOfClassic |
string | The custom CSS for classic stye. |
customCSSOfCircle |
string | The custom CSS for circle stye. |
isTranscriptDownloadAllowed |
bool | Whether the visitor can download the chat transcript. |
isTranscriptSentToVisitors |
bool | Whether visitors can request the chat transcripts or not. |
isTranscriptSentFromCurrentAgentEmail |
bool | Whether the transcript is sent by current agent email, available when isTranscriptDownloadAllowed is true. |
fromEmailName |
string | The from name for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true. |
fromEmailAddress |
string | The from email address for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true. |
isSMTPServerCustomized |
bool | Whether use custom SMTP server or not. |
customSMTPServerFromName |
string | The from name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerFromEmail |
string | The from email address for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerFromMailServer |
string | The mail server for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerPort |
integer | The port for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerEncryptedType |
string | Allowed values are "none", "ssl", "tls". |
isAuthenticationRequiredForCustomSMTPServer |
bool | Whether the authentication is required or not for custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerUserName |
string | The user name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerPassword |
string | The password for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
ifAllowToSwitchToOfflineMessage |
bool | Whether visitors are allowed to switch to offlice message whindow while waiting for chat. |
ifAllowToSendFile |
bool | Whether the agent can send file or not. |
ifMarkUnreadMessage |
bool | Whether the unread message is marked or not. |
isAudioChatEnabled |
bool | Whether this audio chat is enabled or not. |
isVideoChatEnabled |
bool | Whether this video chat is enabled or not. |
isBrowserPopupNotificationEnabled |
bool | Whether this browser popup notification is enabled or not, it is available for private server sites. For shared server clients, the push notificatiton is disabled by default. |
ifEndChatWhenVisitorIsInactive |
bool | Whether the chat ends or not if visitor don't respond in period of time. |
minutesOfVisitorInactivity |
string | Allowed values are "Mins3", "Mins5", "Mins10", "Mins15", "Mins20", "Mins30", "1Hour". |
isTranscriptSentForArchiving |
bool | Whether the transcript is sent for archiving or not. |
receivingEmailAddressesForArchivingTranscripts |
string [] | The email address to receive the transcript that is sent for archiving. |
emailSubjectForArchivingTranscripts |
string | The email subject of the transcript that is sent for archiving. |
greetingMessage |
string | Greeting message of the chat window. |
isCustomJSEnabled |
bool | Whether this custom JS is enabled or not. |
customJS |
string | Custom JS of the chat window. |
isTranscriptPrintAllowed |
bool | Whether the visitor can print the chat transcript or not. |
isChatQueueMaxLengthEnabled |
bool | Whether this chat queue max length is enabled or not. |
chatQueueMaxLength |
integer | The max length of current chat queue. |
chatQueueMaxWaitTime |
integer | The max wait time of current chat queue. |
chatQueueLimitsMessage |
string | The message limits of current chat queue. |
circleStyleHeaderType |
string | Allowed values are "agent", "banner". |
popupChatWindowTitle |
string | The title of this chat window. Available when type is popupChatWindow. |
bannerImageSource |
string | Allowed values are "fromGallery", "fromMyComputer". |
logoImageSource |
string | Allowed values are "fromGallery", "fromMyComputer". |
builtinChatWindowLogoId |
guid | Id of the default chat window logo. |
builtinChatWindowBannerImageId |
guid | Id of the default chat window banner image . |
ifRemovePoweredBy |
bool | Content of the custom page. |
isSoundNotificationsAllowed |
bool | |
ifAllowToRequestScreenSharing |
bool | |
customLogoImage |
string | Image file key of logo, available when header type is logo. |
customBannerImage |
string | Image file key of banner, available when header type is banner. |
builtinChatWindowBannerImage |
builtinChatWindowBannerImage | Reference to Chat Window Banner Gallery Image. |
builtinChatWindowLogo |
builtinChatWindowLogo | Reference to Chat Window Logo Gallery Image. |
GET livechat/campaigns/{id}/chatWindow
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "chatWindowBannerGalleryImage", "chatWindowLogoGalleryImage". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/chatWindow
Name | Type | In | Required | Description |
---|---|---|---|---|
style |
string | body | no | Allowed values are "classic", "circle", "bubble". |
color |
string | body | no | Color of the chat window. |
type |
string | body | no | Allowed values are "embeddedChatWindow", "popupChatWindow". |
classicStyleHeaderType |
string | body | no | Allowed values are "agent", "banner", "logo". |
isAvatarDisplayed |
bool | body | yes | Whether the avatar of the agent is displayed or not, available when headerType is agentInfo or avatarAndLogo. |
isTitleDisplayed |
bool | body | yes | Whether the title of the agent is displayed or not, available when headerType is agentInfo. |
isBioDisplayed |
bool | body | yes | Whether the bio of the agent is displayed or not, available when headerType is agentInfo. |
isLogoDisplayed |
bool | body | yes | Whether the logo is displayed or not, available when headerType is avatarAndLogo. |
isAvatarDisplayedWithMessage |
bool | body | yes | Whether the avatar of the agent is display or not in the message body, available when style is classic or simple. |
isBackgroundDisplayed |
bool | body | yes | Whether the texture and picture of the background is display or not in the message body, available when style is classic or simple. |
backgroundTexture |
string | body | yes | Allowed values are "style1", "style2", "style3", "style4", "style5". |
customCSSOfClassic |
string | body | no | The custom CSS for classic stye. |
customCSSOfCircle |
string | body | no | The custom CSS for circle stye. |
isTranscriptDownloadAllowed |
bool | body | yes | Whether the visitor can download the chat transcript. |
isTranscriptSentToVisitors |
bool | body | yes | Whether visitors can request the chat transcripts or not. |
isTranscriptSentFromCurrentAgentEmail |
bool | body | yes | Whether the transcript is sent by current agent email, available when isTranscriptDownloadAllowed is true. |
fromEmailName |
string | body | yes | The from name for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true. |
fromEmailAddress |
string | body | yes | The from email address for sending transcript email, available when isTranscriptSentFromCurrentAgentEmail is true. |
isSMTPServerCustomized |
bool | body | yes | Whether use custom SMTP server or not. |
customSMTPServerFromName |
string | body | yes | The from name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerFromEmail |
string | body | yes | The from email address for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerFromMailServer |
string | body | yes | The mail server for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerPort |
integer | body | no | The port for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerEncryptedType |
string | body | yes | Allowed values are "none", "ssl", "tls". |
isAuthenticationRequiredForCustomSMTPServer |
bool | body | yes | Whether the authentication is required or not for custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerUserName |
string | body | no | The user name for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
customSMTPServerPassword |
string | body | no | The password for sending transcript email using custom SMTP server, available when isSMTPServerCustomized is true. |
ifAllowToSwitchToOfflineMessage |
bool | body | yes | Whether visitors are allowed to switch to offlice message whindow while waiting for chat. |
ifAllowToSendFile |
bool | body | yes | Whether the agent can send file or not. |
ifMarkUnreadMessage |
bool | body | yes | Whether the unread message is marked or not. |
isAudioChatEnabled |
bool | body | yes | Whether this audio chat is enabled or not. |
isVideoChatEnabled |
bool | body | yes | Whether this video chat is enabled or not. |
isBrowserPopupNotificationEnabled |
bool | body | yes | Whether this browser popup notification is enabled or not, it is available for private server sites. For shared server clients, the push notificatiton is disabled by default. |
ifEndChatWhenVisitorIsInactive |
bool | body | yes | Whether the chat ends or not if visitor don't respond in period of time. |
minutesOfVisitorInactivity |
string | body | yes | Allowed values are "Mins3", "Mins5", "Mins10", "Mins15", "Mins20", "Mins30", "1Hour". |
isTranscriptSentForArchiving |
bool | body | yes | Whether the transcript is sent for archiving or not. |
receivingEmailAddressesForArchivingTranscripts |
string [] | body | yes | The email address to receive the transcript that is sent for archiving. |
emailSubjectForArchivingTranscripts |
string | body | yes | The email subject of the transcript that is sent for archiving. |
greetingMessage |
string | body | no | Greeting message of the chat window. |
isCustomJSEnabled |
bool | body | yes | Whether this custom JS is enabled or not. |
customJS |
string | body | no | Custom JS of the chat window. |
isTranscriptPrintAllowed |
bool | body | yes | Whether the visitor can print the chat transcript or not. |
isChatQueueMaxLengthEnabled |
bool | body | yes | Whether this chat queue max length is enabled or not. |
chatQueueMaxLength |
integer | body | yes | The max length of current chat queue. |
chatQueueMaxWaitTime |
integer | body | yes | The max wait time of current chat queue. |
chatQueueLimitsMessage |
string | body | no | The message limits of current chat queue. |
circleStyleHeaderType |
string | body | no | Allowed values are "agent", "banner". |
popupChatWindowTitle |
string | body | yes | The title of this chat window. Available when type is popupChatWindow. |
bannerImageSource |
string | body | no | Allowed values are "fromGallery", "fromMyComputer". |
logoImageSource |
string | body | no | Allowed values are "fromGallery", "fromMyComputer". |
builtinChatWindowLogoId |
guid | body | yes | Id of the default chat window logo. |
builtinChatWindowBannerImageId |
guid | body | yes | Id of the default chat window banner image . |
ifRemovePoweredBy |
bool | body | no | Content of the custom page. |
isSoundNotificationsAllowed |
bool | body | yes | |
ifAllowToRequestScreenSharing |
bool | body | yes | |
customLogoImage |
string | body | no | Image file key of logo, available when header type is logo. |
customBannerImage |
string | body | no | Image file key of banner, available when header type is banner. |
Sample Request:
Response:
HTTP/1.1 200 OK
Chat Window Banner Gallery Image is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the chat window banner gallery image. |
order |
integer | Order of the chat window banner gallery image. |
isVisible |
bool | Whether the chat window gallery image is visibled or not. |
bannerImage |
string | Image file key of banner, available when classicStyleHeaderType is banner. |
GET livechat/chatWindowBannerGalleryImages
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/chatWindowBannerGalleryImages/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
Chat Window Logo Gallery Image is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the chat window logo gallery image. |
order |
integer | Order of the chat window logo gallery image. |
logoImage |
string | Image file key of logo, available when classicStyleHeaderType is logo. |
GET livechat/chatWindowLogoGalleryImages
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/chatWindowLogoGalleryImages/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
Pre-chat is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
isEnabled |
bool | Whether pre-chat is enabled or not. |
isTeamNameDisplayed |
bool | Whether the team name is displayed or not. |
isAgentAvatarDisplayed |
bool | Whether the agent avatar is displayed or not. |
greetingMessage |
string | Content of the greeting message. |
facebookLogin |
bool | Whether facebook login is enabled or not. |
isVisitorInfoRecorded |
bool | Whether pre-chat info is remembered or not. |
formFieldLayoutStyle |
string | The layout style of the field display.Allowed values are "leftofInput", "aboveInput". |
displayTeamName |
string | Team name displayed in the header. |
isGoogleReCaptchaEnabled |
bool | Whether Google reCAPTCHA is enabled or not. |
captchaLabelText |
string | Label text of the Google reCAPTCHA. |
popUpPreChatTitle |
string | Title of the popup window. |
isInputAreaEnabledWhenUsedInPreChat |
bool | Whether the input area is enabled or not, only available when the type is taskbot. |
type |
string | Allowed values are "form", "taskbot". |
taskbotId |
guid | Id of the taskbot. |
preChatFormFields |
preChatFormFields[] | Reference to Pre-chat Form Field. |
GET livechat/campaigns/{id}/preChat
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "preChatFormField". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns/{id}/preChat:disable
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns/{id}/preChat:enable
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/preChat
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether pre-chat is enabled or not. |
isTeamNameDisplayed |
bool | body | no | Whether the team name is displayed or not. |
isAgentAvatarDisplayed |
bool | body | no | Whether the agent avatar is displayed or not. |
greetingMessage |
string | body | no | Content of the greeting message. |
facebookLogin |
bool | body | no | Whether facebook login is enabled or not. |
isVisitorInfoRecorded |
bool | body | no | Whether pre-chat info is remembered or not. |
formFieldLayoutStyle |
string | body | no | The layout style of the field display.Allowed values are "leftofInput", "aboveInput". |
displayTeamName |
string | body | yes | Team name displayed in the header. |
isGoogleReCaptchaEnabled |
bool | body | no | Whether Google reCAPTCHA is enabled or not. |
captchaLabelText |
string | body | yes | Label text of the Google reCAPTCHA. |
popUpPreChatTitle |
string | body | yes | Title of the popup window. |
isInputAreaEnabledWhenUsedInPreChat |
bool | body | yes | Whether the input area is enabled or not, only available when the type is taskbot. |
type |
string | body | yes | Allowed values are "form", "taskbot". |
taskbotId |
guid | body | no | Id of the taskbot. |
preChatFormFields |
preChatFormFields[] | body | no | Reference to Pre-chat Form Field. |
Sample Request:
Response:
HTTP/1.1 200 OK
Pre-chat Form Field is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the pre chat form field. |
campaignId |
guid | Id of the campaign. |
fieldId |
guid | Id of the field. |
label |
string | The label of the field. |
isVisible |
bool | Whether the field displayed or not. |
isRequired |
bool | Whether the field required or not. |
order |
integer | Order of the field. |
field |
field | Reference to LiveChat_Field. |
GET livechat/preChatFormFields
Name | Type | In | Required | Description |
---|---|---|---|---|
isSystem |
bool | query | no | Whether the field is visible or not. |
An array of Pre-chat Form Field
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/preChatFormFields/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
Canned Message is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
isEnabled |
bool | Whether canned message is enabled or not. |
campaignId |
guid | Id of the campaign. |
publicCannedMessageCategoryIds |
array | The list of the canned message config identifiers of campaign, which the public canned message category is related to. |
GET livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "publicCannedMessageCategory", "campaignLanguage". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:disable
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig:enable
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/campaignLinkingToCannedMessageCategoriesConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether canned message is enabled or not. |
publicCannedMessageCategoryIds |
array | body | no | The list of the canned message config identifiers of campaign, which the public canned message category is related to. |
Sample Request:
Response:
HTTP/1.1 200 OK
Offline Message is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign which the chat window belongs to. |
type |
string | Allowed values are "systemOfflineMessageWindow", "customOfflineMessagePage", "triggerTaskbot". |
customOfflineMessagePageURL |
string | URL of custom offline message page. |
ifOpenCustomOfflineMessagePageInNewWindow |
bool | Whether to open the custom offline message page in a new window or not. |
greetingMessage |
string | Content of the greeting message. |
emailOfflineMessageTo |
string | Allowed values are "allAgent", "customEmailAddress". |
customEmailAddresses |
string | Customize the offline message receiving mailbox |
isTeamNameDisplayed |
bool | Whether the name of the agent is visible or not in the header. |
isAgentAvatarDisplayed |
bool | Whether the avatar of the agent is visible or not in the header. |
displayTeamName |
string | The team name displayed in the header. |
formFieldLayoutStyle |
string | Allowed values are "leftofInput", "aboveInput". |
popUpOfflineMessageTitle |
string | Pop Up offline message Title. |
isInputAreaEnabledWhenUsedInOfflineMessage |
bool | Whether the input area is enabled or not, only available when the type is trigger taskbot. |
taskbotId |
guid | Id of the taskbot. |
fieldResults |
offlineMessageFormFields[] | Reference to Offline Message Form Field. |
GET livechat/campaigns/{id}/offlineMessageConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "offlineMessageFormField". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/offlineMessageConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
type |
string | body | no | Allowed values are "systemOfflineMessageWindow", "customOfflineMessagePage", "triggerTaskbot". |
customOfflineMessagePageURL |
string | body | yes | URL of custom offline message page. |
ifOpenCustomOfflineMessagePageInNewWindow |
bool | body | no | Whether to open the custom offline message page in a new window or not. |
greetingMessage |
string | body | no | Content of the greeting message. |
emailOfflineMessageTo |
string | body | no | Allowed values are "allAgent", "customEmailAddress". |
customEmailAddresses |
string | body | no | Customize the offline message receiving mailbox |
isTeamNameDisplayed |
bool | body | no | Whether the name of the agent is visible or not in the header. |
isAgentAvatarDisplayed |
bool | body | no | Whether the avatar of the agent is visible or not in the header. |
displayTeamName |
string | body | yes | The team name displayed in the header. |
formFieldLayoutStyle |
string | body | no | Allowed values are "leftofInput", "aboveInput". |
popUpOfflineMessageTitle |
string | body | yes | Pop Up offline message Title. |
isInputAreaEnabledWhenUsedInOfflineMessage |
bool | body | yes | Whether the input area is enabled or not, only available when the type is trigger taskbot. |
taskbotId |
guid | body | no | Id of the taskbot. |
offlineMessageFormFields |
offlineMessageFormFields[] | body | no | Reference to Offline Message Form Field. |
Sample Request:
Response:
HTTP/1.1 200 OK
Offline Message Form Field is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the field. |
campaignId |
guid | Id of the campaign which the offline message belongs to. |
fieldId |
guid | Id of the field which the offline message belongs to. |
label |
string | Label of the offline message field. |
isVisible |
bool | Whether offline message form field is visible or not. |
isRequired |
bool | Whether offline message form field is required or not. |
order |
integer | Order of the option. |
field |
field | Reference to LiveChat_Field. |
GET livechat/offlineMessageFormFields
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/offlineMessageFormFields/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
Post-chat is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
greetingMessage |
string | Greeting message of post-chat. |
isEnabled |
bool | Whether post-chat is enabled or not. |
formFieldLayoutStyle |
string | Allowed values are "leftofInput", "aboveInput". |
postChatFormFields |
postChatFormFields[] | Reference to Post Chat Form Field. |
GET livechat/campaigns/{id}/postChat
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "postChatFormField". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns/{id}/postChat:disable
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/campaigns/{id}/postChat:enable
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/postChat
Name | Type | In | Required | Description |
---|---|---|---|---|
greetingMessage |
string | body | no | Greeting message of post-chat. |
isEnabled |
bool | body | no | Whether post-chat is enabled or not. |
formFieldLayoutStyle |
string | body | no | Allowed values are "leftofInput", "aboveInput". |
postChatFormFields |
postChatFormFields[] | body | no | Reference to Post Chat Form Field. |
Sample Request:
Response:
HTTP/1.1 200 OK
Post Chat Form Field is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the post chat form field. |
campaignId |
guid | Id of the campaign. |
fieldId |
guid | Id of the field. |
label |
string | Label of the field. |
isVisible |
bool | Whether the post chat form field is visible or not. |
isRequired |
bool | Whether the post chat form field is required or not. |
order |
integer | Order of the post chat form field. |
field |
field | Reference to LiveChat_Field. |
ratingGrades |
ratingGrades[] | Reference to Rating Grade. |
GET livechat/postChatFormFields
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "campaignRatingGrade". |
An array of Post Chat Form Field
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/postChatFormFields/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "campaignRatingGrade". |
Sample Request:
Response:
HTTP/1.1 200 OK
Rating Grade is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the rating grade. |
postChatFormFieldId |
guid | Id of the field. |
grade |
string | Allowed values are "Scale 1", "Scale 2", "Scale 3", "Scale 4", "Scale 5". |
label |
string | The label of the rating grade. |
isVisible |
bool | Whether the rating grade displayed or not. |
GET livechat/ratingGrades
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/ratingGrades/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/ratingGrades/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
postChatFormFieldId |
guid | body | no | Id of the field. |
grade |
string | body | no | Allowed values are "Scale 1", "Scale 2", "Scale 3", "Scale 4", "Scale 5". |
label |
string | body | no | The label of the rating grade. |
isVisible |
bool | body | no | Whether the rating grade displayed or not. |
Sample Request:
Response:
HTTP/1.1 200 OK
KB Integration is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
isEnabled |
bool | Whether KB integration is enabled or not. |
selectedKbId |
guid | Id of the selected KB. |
isSearchAllowedBeforeChatting |
bool | Whether allow search KB before chatting or not. |
isSearchAllowedBeforeOfflineMessage |
bool | Whether allow search KB before leaving a message or not. |
articlesShowedInSearchResult |
integer | Maximum number of articles showed in search result. |
greetingMessageBeforeChatting |
string | The greeting message before chatting. |
greetingMessageBeforeOfflineMessage |
string | The greeting message before leaving a message. |
campaignId |
guid | Id of the campaign. |
GET livechat/campaigns/{id}/integrationKbConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "knowledgeBase". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/integrationKbConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether KB integration is enabled or not. |
selectedKbId |
guid | body | yes | Id of the selected KB. |
isSearchAllowedBeforeChatting |
bool | body | no | Whether allow search KB before chatting or not. |
isSearchAllowedBeforeOfflineMessage |
bool | body | no | Whether allow search KB before leaving a message or not. |
articlesShowedInSearchResult |
integer | body | no | Maximum number of articles showed in search result. |
greetingMessageBeforeChatting |
string | body | no | The greeting message before chatting. |
greetingMessageBeforeOfflineMessage |
string | body | no | The greeting message before leaving a message. |
Sample Request:
Response:
HTTP/1.1 200 OK
Routing Rule is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
isEnabled |
bool | Whether routing rule is enabled or not. |
type |
string | Allowed values are "simple", "customRules". |
routeToTypeForSimpleRouting |
string | Allowed values are "department", "agent". |
priorityForSimpleRouting |
string | Allowed values are "lowest", "low", "normal", "high", "highest". |
percentageToBot |
integer | Percentage to bot. |
actionWhenNoRuleMatched |
string | Allowed values are "routeToDepartmentorAgent", "redirectToOfflineMessage". |
routeToTypeWhenNoRuleMatched |
string | Allowed values are "department", "agent". |
priorityWhenNoRuleMatched |
string | Allowed values are "lowest", "low", "normal", "high", "highest". |
percentageToBotWhenNoRuleMatched |
integer | Percentage to bot when no rule matched. |
emailsToReceiveOfflineMessage |
string [] | The list of emails to receive offline message. |
noRuleMatchedRouteToAgentId |
guid | Id of the agent to be routed when visitors fail to be routed based on any of the custom rules. |
simpleRoutingRouteToAgentId |
guid | Id of the agent when route visitors to. |
simpleRoutingRouteToDepartmentId |
guid | Id of the department when route visitors to. |
noRuleMatchedRouteToDepartmentId |
guid | Id of the agent to be routed when visitors fail to be routed based on any of the custom rules. |
simpleRouteToSkillInDepartmentId |
guid | |
routeToSkillInDepartmentWhenNoRuleMatchedId |
guid | |
routingRules |
routingRules[] | Reference to LiveChat_CampaignRoutingRule. |
GET livechat/campaigns/{id}/routingConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "campaignRoutingRule". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/routingConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether routing rule is enabled or not. |
type |
string | body | no | Allowed values are "simple", "customRules". |
routeToTypeForSimpleRouting |
string | body | no | Allowed values are "department", "agent". |
priorityForSimpleRouting |
string | body | yes | Allowed values are "lowest", "low", "normal", "high", "highest". |
percentageToBot |
integer | body | no | Percentage to bot. |
actionWhenNoRuleMatched |
string | body | no | Allowed values are "routeToDepartmentorAgent", "redirectToOfflineMessage". |
routeToTypeWhenNoRuleMatched |
string | body | no | Allowed values are "department", "agent". |
priorityWhenNoRuleMatched |
string | body | yes | Allowed values are "lowest", "low", "normal", "high", "highest". |
percentageToBotWhenNoRuleMatched |
integer | body | no | Percentage to bot when no rule matched. |
emailsToReceiveOfflineMessage |
string [] | body | no | The list of emails to receive offline message. |
noRuleMatchedRouteToAgentId |
guid | body | yes | Id of the agent to be routed when visitors fail to be routed based on any of the custom rules. |
simpleRoutingRouteToAgentId |
guid | body | yes | Id of the agent when route visitors to. |
simpleRoutingRouteToDepartmentId |
guid | body | yes | Id of the department when route visitors to. |
noRuleMatchedRouteToDepartmentId |
guid | body | yes | Id of the agent to be routed when visitors fail to be routed based on any of the custom rules. |
simpleRouteToSkillInDepartmentId |
guid | body | no | |
routeToSkillInDepartmentWhenNoRuleMatchedId |
guid | body | no | |
routingRules |
routingRules[] | body | no | Reference to LiveChat_CampaignRoutingRule. |
Sample Request:
Response:
HTTP/1.1 200 OK
LiveChat_CampaignRoutingRule is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the rule. |
campaignId |
guid | Id of the campaign. |
isEnabled |
bool | Whether rule is enabled or not. |
order |
integer | Order of the rule. |
routeToType |
string | Allowed values are "department", "agent". |
priority |
string | Allowed values are "lowest", "low", "normal", "high", "highest". |
percentageToBot |
integer | Percentage to bot |
conditionMetType |
string | Allowed values are "all", "any", "logicalExpression". |
logicalExpression |
string | Detail of the logic expression. |
routeToDepartmentId |
guid | Id of the department when route visitors to. |
routeToAgentId |
guid | Id of the agent when route visitors to. |
name |
string | Name of the rule. |
simpleRouteToSkillInDepartmentId |
guid | |
routingRuleConditions |
routingRuleConditions[] | Reference to Routing Rule Condition. |
routeToAgent |
routeToAgent | Reference to Agent. |
routeToDepartment |
routeToDepartment | Reference to Department. |
POST livechat/routingRules/{id}:disable
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/routingRules/{id}:enable
Sample Request:
Response:
HTTP/1.1 200 OK
AI Chatbot is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
isEnabled |
bool | Whether bot is enabled or not. |
selectedChatBotId |
guid | Id of selected bot. |
isChatbotAllocatedWhenAgentOnline |
bool | Whether allocate chats to bot when agents are online or not. |
isChatbotAllocatedWhenAgentOffline |
bool | Whether allocate chats to bot when agents are offline or not. |
distributeChatsToChatbotOption |
string | Allowed values are "byQueueLength", "byPercentage". |
queueLength |
integer | Reached queue length to allocate when agents are online. |
percentageToChatbot |
integer | Probability of chats being distributed to bot when agents are online. |
isDistributeChatsWhenQueueLengthReachesEnabled |
bool | Whether allocate chats when queue length reaches or not. |
GET livechat/campaigns/{id}/integrationChatBotConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "chatbot". |
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/integrationChatBotConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether bot is enabled or not. |
selectedChatBotId |
guid | body | yes | Id of selected bot. |
isChatbotAllocatedWhenAgentOnline |
bool | body | no | Whether allocate chats to bot when agents are online or not. |
isChatbotAllocatedWhenAgentOffline |
bool | body | no | Whether allocate chats to bot when agents are offline or not. |
distributeChatsToChatbotOption |
string | body | yes | Allowed values are "byQueueLength", "byPercentage". |
queueLength |
integer | body | yes | Reached queue length to allocate when agents are online. |
percentageToChatbot |
integer | body | yes | Probability of chats being distributed to bot when agents are online. |
isDistributeChatsWhenQueueLengthReachesEnabled |
bool | body | no | Whether allocate chats when queue length reaches or not. |
Sample Request:
Response:
HTTP/1.1 200 OK
LiveChat_CampaignManualInvitation is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
style |
string | Allowed values are "bubble", "chatWindow". |
invitationMessage |
string | Message shown in manual invitation window. |
position |
string | Allowed values are "centered", "centeredWithOverlayBackground", "bottomRight", "middleLeft", "middleRight". |
bubbleInvitationHeader |
string | Allowed values are "agentAvatar", "image". |
isTypingAreaDisplayed |
bool | |
headerImage |
image | |
textBackgroundColor |
string |
GET livechat/campaigns/{id}/manualInvitation
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/campaigns/{id}/manualInvitation
Name | Type | In | Required | Description |
---|---|---|---|---|
style |
string | body | yes | Allowed values are "bubble", "chatWindow". |
invitationMessage |
string | body | no | Message shown in manual invitation window. |
position |
string | body | yes | Allowed values are "centered", "centeredWithOverlayBackground", "bottomRight", "middleLeft", "middleRight". |
bubbleInvitationHeader |
string | body | no | Allowed values are "agentAvatar", "image". |
isTypingAreaDisplayed |
bool | body | no | |
headerImage |
image | body | no | |
textBackgroundColor |
string | body | no |
Sample Request:
Response:
HTTP/1.1 200 OK
Language is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
isCustomLanguageEnabled |
bool | Whether the campaign used custom language or not. |
isTextDirectionRightToLeft |
bool | Whether the campaign's custom language text directed from right to left or not. |
campaign |
campaign | Reference to Campaign. |
customLanguageItems |
customLanguageItems[] | Reference to Custom Language. |
GET livechat/campaigns/{id}/languageConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "campaign", "campaignLanguage". |
Sample Request:
Response:
HTTP/1.1 200 OK
GET livechat/campaigns/{id}/LanguageItems
Sample Request:
Response:
HTTP/1.1 200 OK