Data Structure for Chat Widget

Attribute Name Base Type Restrictions Description

id

int

minOccurs = 0

minValue = 1

maxValue = 2147483647

Unique ID for each widget.

name

string

minLength = 1

maxLength = 50

occurrences = 1

Regex = ([ ^<>~`!@#$%? &*()=[]{};,/ '+:.,"])+

Name of the chat widget.

description

string

minLength = 1

maxLength = 50

occurrences = 1

Regex = ([^ <>~`!@#$%? &*()=[]{};,/ '+:.,"])+

Description of the widget that is configured in Unified CCX Administration.

contextServiceFieldsets

string

minLength = 1

maxLength = 1024

maxOccurs = 1

minOccurs = 0

Regex = ([ 0-9a-zA-Z]+([,._-] [0-9a-zA-Z]+)*)*

Valid fieldsets that will be entered by the Admin while configuring the chat widgets.

Note

  • Fieldsets are comma separated strings in the format fieldset1,fieldset2 (for example: cisco.base.pod, cisco.ccx.pod).

  • All the Selected User Form Fields except Name and Email should be part of the FieldSets specified, otherwise Context Service operations for chat will fail.

  • To perform Context Service Lookup Customer for chat, the Email field is mandatory in the chat form.

formField

string

minLength = 1

maxLength = 50

minOccurs = 1

maxOccurs = 10

Regex = ([^ <>~`!@#$%? &*()=[]{};,/ '+:.,"])+

Fields that are present in the form.

welcomeMessage

string

minLength = 1

maxLength = 90

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = "Thank you for contacting us. A customer care representative would assist you soon."

Message that is displayed to the customer when the chat form is submitted.

agentJoinTimeoutMsg

string

minLength = 1

maxLength = 90

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = "All our customer care representatives are busy. You may wait or try again later."

Message that is displayed to the customer when a chat request is not handled within the set time.

chatErrorMsg

string

minLength = 1

maxLength = 90

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = "Chat service is currently unavailable. Try later. "

Message that is displayed to the customer when Unified CCX or chat service is not available to handle chat requests.

problemStatementCSQPair

problemStatementcsq

minOccurs = 1

maxOccurs = Unbounded

Definition of the problem.

type

string

minOccurs = 0

maxOccurs = 1

Indicates the type of widget:

  • Default : bubble

bubbleStyle

bubbleStyle

minOccurs = 0

maxOccurs = 1

Provides styling information of the chat bubble.

bubbleMessages

bubbleMessages

minOccurs = 0

maxOccurs = 1

Text messages displayed on the chat bubble.

calendarDetails

calendarDetails

minOccurs = 0

maxOccurs = 1

Provides details of calendars and its corresponding messages that are associated with the chat widget.