This module has been designed to get the data for chat transcript. The Service URL of the module is given by the following link-
https://www.enterice.com/external/icedataapi/api/chat/get_chat_transcript_data
- Json Formats-
- Code snippet for Web Service Use-
GET_CHAT_TRANSCRIPT_DATA
{
‘Token’:’dfasdfasdf’,
‘FromDateTime’:’07/06/2018 12:00:00 AM’,
‘ToDateTime’:’07/10/2018 11:59:00 PM’,
‘TimeZoneOffset’:-240,
‘SkillID’:822,
‘AgentID’:2003,
‘OrgID’:168
}
Notes:
- Only single skill data will be accessible at a time
- Value of ‘AgentID’ should be 0 (zero) for all agents data
2. Description for Request Parameter-
Request Parameters | Notes | ||||||||||||||||||||||||||||||||||
Token | string | Authentication Token | |||||||||||||||||||||||||||||||||
FromDateTime | string | From Date and Time | |||||||||||||||||||||||||||||||||
ToDateTime | string | To Date and Time | |||||||||||||||||||||||||||||||||
TimeZoneOffset | integer | Time zone offset of specific time zone |
|
||||||||||||||||||||||||||||||||
SkillID | integer | Skill id | Only single skill data will be accessible at a time | ||||||||||||||||||||||||||||||||
AgentID | integer | Agent id | Value of ‘AgentID’ should be 0 (zero) for all agents data
|
||||||||||||||||||||||||||||||||
OrgID | integer | Organization Id |
3. Response Example-
Success:
{
“ChatTranscript”: [
{
“ChatID”: “1234”,
“AgentName”: “John”,
“VisitorName”: “Maria”,
“ChatStartTime”: “05:10:00”,
“ChatEndTime”: “05:13:25”,
“Transcript”: “<ChatHistory><MessageContent><MessageType>OperatorConnect</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:56</TimeStamp><Message><![CDATA[John joined the conversation]]></Message><SenderName>mani</SenderName><Sender>System</Sender></MessageContent><MessageContent><MessageType>GreetingMessage</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:56</TimeStamp><Message><![CDATA[Welcome to ICE]]></Message><SenderName>John</SenderName><Sender>System</Sender></MessageContent><MessageContent><MessageType>Message</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:57</TimeStamp><Message><![CDATA[Hello]]></Message><SenderName>mani</SenderName><Sender>operator</Sender></MessageContent><MessageContent><MessageType>Message</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:58</TimeStamp><Message><![CDATA[Hi]]></Message><SenderName>mani</SenderName><Sender>operator</Sender></MessageContent><MessageContent><MessageType>CustomerHangUp</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:56:05</TimeStamp><Message><![CDATA[<div><font color=”#FF****”>Maria left the conversation </font></div>]]></Message><SenderName>s</SenderName><Sender>System</Sender></MessageContent></ChatHistory>“,
“Browser”: “Chrome 50.1”,
“IP”: “27.460.450.1”,
“OS”: “Window-10”
},
{
“ChatID”: “1235”,
“AgentName”: “John”,
“VisitorName”: “Maria”,
“ChatStartTime”: “05:10:00”,
“ChatEndTime”: “05:13:25”,
“Transcript”: “<ChatHistory><MessageContent><MessageType>OperatorConnect</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:56</TimeStamp><Message><![CDATA[John joined the conversation]]></Message><SenderName>mani</SenderName><Sender>System</Sender></MessageContent><MessageContent><MessageType>GreetingMessage</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:56</TimeStamp><Message><![CDATA[Welcome to ICE]]></Message><SenderName>John</SenderName><Sender>System</Sender></MessageContent><MessageContent><MessageType>Message</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:57</TimeStamp><Message><![CDATA[Hello]]></Message><SenderName>mani</SenderName><Sender>operator</Sender></MessageContent><MessageContent><MessageType>Message</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:55:58</TimeStamp><Message><![CDATA[Hi]]></Message><SenderName>mani</SenderName><Sender>operator</Sender></MessageContent><MessageContent><MessageType>CustomerHangUp</MessageType><TimeZone>GMT</TimeZone><TimeStamp>07/09/2018 08:56:05</TimeStamp><Message><![CDATA[<div><font color=”#FF****”>Maria left the conversation </font></div>]]></Message><SenderName>s</SenderName><Sender>System</Sender></MessageContent></ChatHistory>“,
“Browser”: “Chrome 50.1”,
“IP”: “27.460.450.1”,
“OS”: “Window-10”
}
]
}
Fail:
{ “Status”: “ false”,
“Message”:”as above.”,
“Error”: “as above”
}