Access Keys:
Skip to content (Access Key - 0)
Live Chat

Entities Used in Deployments CRUD

Skip to end of metadata
Go to start of metadata
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Following is a list of entities used in the deployments CRUD:

  • id: The unique ID for deployment. This is Read Only.
  • name: The deployment's name.
  • creationDate: The time this deployment was being created. This is Read Only.
  • company: The ID of the company to which the deployment belongs. This is Read Only.
  • theme: Theme for this deployment, right now we only have "theme-1".
  • title: Title of the in-place chat dialog.
  • copyright: Copyright displayed in the chat dialog. NOTE: Right now we have only one theme, and this theme doesn't support copyright. This is Unused.
  • unavailableMessage: Displayed when there is no operator to serve the visitor. This is Unused.
  • waitingMessage: Displayed in visitor's chat dialog when visitor is waiting for operator to serve.
  • welcomeMessage: Displayed in visitor's chat dialog when some operator has accepted the chat request.
  • finalMessage: Displayed in visitor's chat dialog when the chat conversation ends.
  • departments: Departments associated with this deployment. Separated by semi-colon ";".
  • exitSurvey: A survey's ID, when this field is assigned, the survey can be referenced in the waitingMessage/unavailableMessage/welcomeMessage/finalMessage by inserting Link Name into the message.
  • enableAutoInvite: Toggle flag to check whether the automatic invite is enabled. When the automatic invitation is enabled for an active deployment, the visitor will see an in-place chat invitation widget when the inviteTimeout has reached.
  • inviteTimeout: Timeout for automatic invite, measured in Seconds.
  • enableProactiveInvite: Enables proactive invite, only when proactive invite has enabled, the operator can send invitation from the browse list.
  • enableInvitationFilter: Enables invitation filter. This filter affects both proactive invitation and automatic invitation.
  • invitationFilter: URL list. Each line represents a URL. This is used to activate automatic chat invitation on specific pages.
  • invitationFilterType: Specify how the filter affects invitation, 0 means this is a white list, only when the URL is in the filter, the invitation can work. 1 means this is a black list, the invitation will not work if the URL is within the filters.
  • linkType: This is Unused.
  • themeFlags: A binary combination of following values: 1 (Hide Logo), 2 (Hide Powered By), 4 (Hide Email Link), 8 (Hide Save Link), 16 (Hide Print Link), 32 (Hide Security Seal).
  • transcriptStyle: Style for transcript area, data is encoded in following format:
    Font style uses i stand for italic, b for bold, u for underline.
    Example: 12;bi;#cc00cc;Arial;#ffffff;#ffffff, means the font size is 12px, with bold and italic style and color #cc00cc, font family is Arial, background and border color is #ffffff.
  • textboxStyle: Style for text boxes, the format has the same format with transcriptStyle.
  • enableTranslate: Toggle flag whether the translation is enabled. Translation can work only when this is enabled, visitor and operator has different languages, translation will affect in-place widget and translate visitor's message into operator's language, and operator's message to visitor's language.
  • operatorLanguage: Operator's language, language codes can be found at
  • visitorLanguage: Visitor's language, set this field to empty in order to allow system detect visitor's language from HTTP header.
Adaptavist Theme Builder (4.2.0) Powered by Atlassian Confluence 3.3, the Enterprise Wiki