Get a ticket
Get a ticket by ticketId
Authorizations
Cookie-based authentication
Path Parameters
The id of the ticket to retrieve
Query Parameters
Trigger a hard refresh (incl. re-sync of contract from powercloud and freshdesk) before?
Response
A ticket, e.g. an email conversation, call or chat conversation. When fullData=false, some fields (body, bodyPlain, attachments, etc.) will be omitted.
Sender of email. Used when channel is not call. Null is channel=system
Provided when customer's request included a Name, e.g. 'Tom Mustermann tom@mm.com' for an email or during the chat bot initialization. Null when not set
Recipent of request. Can be an array of email addresses, but also a phone number or chat group name depending on channel
E-Mail address, used when channel is email,portal,chat
Any emails in CC. Used when channel=email, otherwise empty array
Any emails in CC for a reply. Used when channel=email, otherwise empty array
ID of the subchannel
AI-detected sentiment
Detected language name
Detected language code
When the ticket should be auto-executed
Level of AI support for this ticket
unprocessed
, human
, bot
, automated
Whether the customer is currently active
Name of the ticketing system interface
internal
, Freshdesk
, api
Priority of ticket
low
, medium
, high
, urgent
Channel of ticket
email
, portal
, phone
, letter
, system
, chat
, walkIn
Unique ID of chat conversation. Used when channel=chat
Status of ticket
open
, pending
, resolved
, closed
, waitingOnCustomer
, waitingOnThirdParty
Summary of request
Subject of email
Body of request in plain text form (no HTML)
Body of request in originial form (incl. HTML)
Last change of this ticket
Latest date by when this ticket should be responded to, but not necessarily solved
Latest date by when this ticket should be resolved
Date when this ticket was closed/resolved
Associated primary customer id of that ticket. Null if not detected by AI or not set by user
Associated primary contract id of that ticket. Null if not detected by AI or not set by user
Associated partner id of that ticket. Null if not detected by AI or not set by user
Customer legitimation score:
- 0 = No customer identified or no contract associated
- 10 = Default confidence for email/portal/chat channels when no other criteria match
- 12 = Email not found in ERP system
- 13 = Matching contract/customer ID and lastname found in message
- 15 = Matching contract and customer ID found in message
- 20 = High confidence cases:
- System channel or outgoing/internal messages
- Sender email matches contract/customer email
- For letters: address matches customer/contract address
- 30 = Manually confirmed by agent or AI during chat
- 40+ = Custom level that will be set by agent/chatbot for more strict customer verification
User ID of agent that authored the latest response to this ticket.
Agent ID associated to this ticket (if any).
Array of agent IDs that are assigned to this ticket
Agent ID
Array of agents that are assigned to this ticket
Array of agent IDs that worked on this ticket in last hour
Agent ID
Array of agent IDs that worked on this ticket in last hour
Client-specific data objects can be included here
Generic template (independent on intent)
Tags loaded from intents
Tag object
If false, the agent doesn't have the skills to handle the ticket
If a workitem (a.k.a. system dropout or action) is attached to this ticket, the source data is shown here