GET (Chat Config)

URL:

https://<SM_FQDN>/ccp/rest/bubblechat?<query parameter>

HTTPS method:

GET

Input/Output format:

application/json

Parameter

See Bubble Chat API Parameter.

Example JSON response:
GET /ccp/rest/bubblechat?wid=1 HTTPS/1.1
Host: SM-FQDN Accepts: application/json
   
# Response
Status: HTTPS/1.1 200 OK
Payload:
{
"messages": {
"agentJoinTimeoutMsg": "All customer care representatives are busy. Please wait or try again later.",
"chatErrorMsg": "Sorry, the chat service is currently not available. Please try again later.",
"offHourMessage": "Sorry, we are not available at the moment.",
"welcomeMessage": "Welcome. Please wait while we connect you to a customer care representative."
},
"proactiveChat": false,
"contextServiceFieldSets": "com.ccx-social_miner.pod,com.ccx-media_sense.pod",
"chatForm": {
"problemStatements": {
"statements": [
{
"statement": "PL problem statement",
"csqTag": "Chat_Csq3"
},
{
"statement": "HL problem statement",
"csqTag": "Chat_Csq2"
}
],
"caption": "Choose a Problem Statement"
},
"bubbleStyle": {
"titleText": "chat bubble 3",
"titleTextColor": "#1f1f1F",
"buttonText": "chat button 3",
"buttonTextColor": "#1f1f1F",
"buttonBackgroundColor": "#ebebec",
"agentMessageTextColor": "#ebebec",
"agentMessageBackgroundColor": "#1f1f1F",
"fontFace": "Arial"
},
"formFields": [
"Name",
"Details",
"Email",
"PhoneNumber",
"CustomForm"
]
HTTPS response headers:

200 OK

400 Bad Request

404 Not Found

405 Method Not Allowed

500 Internal Server error - due to various internal failure scenarios

See HTTPS Responses for more information about the response codes.