Get Chat Widget (XML)

HTTPS Method

GET

URI

https://<server>/adminapi/chatWidget/<chatWidget id>

Example URI

https://uccx-server/adminapi/chatWidget/2

Accept

Application/XML, Application/JSON

HTTPS Success Code

200

HTTPS Failure Codes

401, 404, 405

Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?>
<chatWidget>
   <self href="https://uccx-server:8080/adminapi/chatWidget/2" rel="self" type="chatWidget"/>
    <id>2</id>
    <name>TestchatWidget0</name>
    <description>TestchatWidget0</description>
    <formField>Name</formField>
    <contextServiceFieldsets>test</contextServiceFieldsets>
    <welcomeMessage>Thank you for contacting us. A customer care representative would assist you soon.</welcomeMessage>
    <agentJoinTimeoutMsg>All our customer care representatives are busy. You may wait or try again later.</agentJoinTimeoutMsg>
    <chatErrorMsg>Chat service is currently unavailable. Try later.</chatErrorMsg>
        <problemStatementCSQPair>
        <problemStatement>chatTest</problemStatement>
        <csq name="chatCSQ1">
            <link href="https://uccx-server:8080/adminapi/csq/1" rel="used by" type="csq"/>
        </csq>
    </problemStatementCSQPair>   
    calendarDetails>
	    <calendar name=“calendar1">
                  <refURL>https://10.107.45.242/adminapi/calendar/1</refURL>
           </calendar>
	    <messages>
	      <holidayMsg>Sorry, We are closed today for a business holiday.</holidayMsg>
	      <offHoursMsg>We are currently offline, try again during the business hours.</offHoursMsg>
	      <businessHoursMsg>Business Hours (Local Time)</businessHoursMsg>
	      <dayOfWeek>
	        <monday>Monday</monday>
	        <tuesday>Tuesday</tuesday>
	        <wednesday>Wednesday</wednesday>
	        <thursday>Thursday</thursday>
	        <friday>Friday</friday>
	        <saturday>Saturday</saturday>
	        <sunday>Sunday</sunday>
	      </dayOfWeek>
	    </messages>
    </calendarDetails>
    <type>bubble</type>
    <bubbleStyle>
        <titleText>chat bubble 1</titleText>
        <titleTextColor>#FF0000</titleTextColor>
        <buttonText>chat button 1</buttonText>
        <buttonTextColor>#FF0000</buttonTextColor>
        <buttonBackgroundColor>#EBEBEC</buttonBackgroundColor>
        <resumeButtonText>Resume Chat</resumeButtonText>
        <agentMessageTextColor>#FF0000</agentMessageTextColor>
        <agentMessageBackgroundColor>#FF0000</agentMessageBackgroundColor>
        <fontType>Arial</fontType>
    </bubbleStyle>
    <bubbleMessages>
        <textForTypingMsg>Type your message and press enter</textForTypingMsg>
        <agentJoinedMsg>${agent_alias} has joined the chat</agentJoinedMsg>
        <agentTypingMsg>${agent_alias} is typing</agentTypingMsg>
        <agentLeftMsg>${agent_alias} has left the chat</agentLeftMsg>
        <afterChatSessionTranscriptPopupMsg>
            <transcriptPopupMsg>Chat has ended. Do you want to download the chat transcript?</transcriptPopupMainMsg>
            <transcriptPopupNegativeMsg>No</transcriptPopupNegativeMsg>
            <transcriptPopupPositiveMsg>Yes</transcriptPopupPositiveMsg>
        </afterChatSessionTranscriptPopupMsg>
        <closeChatConfirmationPopupMsg>
            <closeChatPopupMsg>Do you want to close the chat?</closeChatPopupMainMsg>
            <closeChatPopupNegativeMsg>No</closeChatPopupNegativeMsg>
            <closeChatPopupPositiveMsg>Yes</closeChatPopupPositiveMsg>
        </closeChatConfirmationPopupMsg>
        <connectivityErrorMsg>Chat disconnected due to inactivity timeout or connection failure.</connectivityErrorMsg>
    </bubbleMessages>
</chatWidget>