GET (Chat Transcript)

XML Transcript Download

This API retrieves the transcript for a chat contact, which can be downloaded in the XML format.


URL:	https://<ServerIP>:<Port>/ccp/rest/chat/transcript.xml
HTTPS method:	GET
Example XML response:	`<ChatTranscript><startDate>1389540103973</startDate> <transcript> <chat><time>1389540103973</time><name>Agent</name><msg>Hi</msg></chat> <chat><time>1389540108058</time><name>Dave</name><msg>Hello</msg></chat> <chat><time>1389540111001</time><name>Agent</name><msg>How may I help you?</msg></chat> <chat><time>1389540114026</time><name>Dave</name><msg>I have a query</msg></chat> </transcript> </ChatTranscript>`
Elements:	time: timestamp of the chat in GMT. name: agent or customer name. msg: the chat message.
HTTPS response headers:	400 Bad Request 404 Not Found 501 Not Implemented See HTTPS Responses for more information about the response codes.

HTML Transcript Download

This API retrieves the transcript for a chat contact, which can be downloaded in the HTML format.


URL:	https://<serverIP>:<Port>/ccp/rest/chat/transcript?locale=<locale>
HTTPS method:	GET
HTTPS response headers:	200 OK 400 Bad Request 404 Not Found See HTTPS Responses for more information about the response codes.

The file name of the downloaded HTML is in the following format:

ChatTranscript_<Customer_Name_spaces_replaced_by_underscores>-YYYY_DD_MMM_hh_mm.html

For example, ChatTranscript_John_Doe_2018_26_Jan_13_45.html.

Note

The time zone for all time values mentioned in the HTML is the time zone of the deployed Customer Collaboration Platform server. The time zone is also clearly displayed with each time value.
To use the locale, you must install the language pack in Customer Collaboration Platform. For more information about installing language packs, see the Cisco Customer Collaboration Platform User Guide, available here:

https://www.cisco.com/c/en/us/support/customer-collaboration/socialminer/products-user-guide-list.html

If you do not have the language pack installed, the locale defaults to en_ALL.

The following table lists the strings that you can use for the locale parameter with their associated languages.


String	Language
da_DK	Danish
de_DE	German
en_ALL	English
es_ES	Spanish
fi_FI	Finnish
fr_FR	French (France)
it_IT	Italian
nb_NO	Norwegian
nl_NL	Dutch
pl_PL	Polish
pt_BR	Portuguese
ru_RU	Russian
sv_SE	Swedish
tr_TR	Turkish
zh_CN	Chinese (Simplified)
zh_TW	Chinese (Traditional)
ja_JP	Japanese
ko_KR	Korean

PDF Transcript Download (Not Used for Transcript Download - Used to Redirect to HTML Transcript Download API)

Since Customer Collaboration Platform 11.6(2), this API is not used to download chat transcripts as PDF files. Requests to this API will get unconditionally redirected to the HTML transcript download API (see above).

URL:

https://<serverIP>:<Port>/ccp/rest/chat/transcript.pdf?locale=<locale>

HTTPS method:

GET

HTTPS response headers:

301 Moved Permanently

Note

Since Customer Collaboration Platform 11.6(2), requests to this API gets the response with the HTTP status 301 (MOVED PERMANENTLY) and the Location header of the response contains a complete URL to the HTML Transcript Download API . Most clients (including all browsers) will get automatically redirected to this URL in the Location header. This will avoid any impact to existing third party clients using this API.