POST Agents/Chat/GetChatTranscript
Some tooltip text!
• 3 minutes to read
• 3 minutes to read
POST /api/v1/Agents/Chat/GetChatTranscript
Get the chat transcript, formatted as plain text or html
NsApiSlow threshold: 5000 ms.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. |
POST /api/v1/Agents/Chat/GetChatTranscript?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: request
ChatSessionId, Html
| Property Name | Type | Description |
|---|---|---|
| ChatSessionId | Integer | |
| Html | Boolean |
Response:string
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: string
Sample request
POST /api/v1/Agents/Chat/GetChatTranscript
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8
{
"ChatSessionId": 292,
"Html": false
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
"Chat Session #2347\n\nCustomer: John Smith (john.smith@example.com)\nAgent: Sarah Johnson\nDate: December 15, 2024, 09:23 AM\nTopic: Customer Support\n\n[09:23:15] Sarah Johnson: Hello! How can I help you today?\n[09:23:42] John Smith: Hi, I need help with my recent order\n[09:24:03] Sarah Johnson: Of course! Can you provide your order number?\n[09:24:18] John Smith: It's ORD-2024-5789\n[09:24:35] Sarah Johnson: Thank you! Let me look that up for you.\n[09:25:12] Sarah Johnson: I found your order. It was shipped yesterday and should arrive on December 17th.\n[09:25:28] John Smith: Perfect, thank you so much!\n[09:25:35] Sarah Johnson: You're welcome! Is there anything else I can help you with?\n[09:25:42] John Smith: No, that's all. Thanks!\n[09:25:48] Sarah Johnson: Have a great day!\n\nChat ended at 09:25:50\nRating: 5/5 stars"