Skip to main content
Get Summarize Ticket Prompt

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$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.

Body

TicketId, NumSentences, Summary, IsoLangCode

GetSummarizeTicketPrompt: Return the prompt used to get a short summary of the messages on a ticket. Does not call the chatbot for a response. Used for transfering a summary to a chat session.

TicketId
integer<int32>
NumSentences
integer<int32>
Summary
string
IsoLangCode
string

Response

OK

Chat turn contains one user question, an optional display value for the user prompt, and one chatbot response. Carrier object for ChatbotTurn. Services for the ChatbotTurn Carrier is available from the AI Agent.

Timestamp
string<date-time>

UTC timestamp for turn - when response was generated.

UserPrompt
string

Text from the user

UserDisplayText
string

Optional display value to use instead of the the UserPrompt

BotResponse
string

Text from the chatbot

BotActions
object

optional dictionary of action buttons. Key = Display text, Value = Prompt text

Attachments
string[]

optional array of attachments - can be URL or Base64 encoded data