> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Ticket Message With Embedded Data > Get a ticket message entity with posibillity to change embedded images to be represented with inline data within the HTML body. If using inline data, be sure not to save this back to the database. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-TicketAgent.json post /api/v1/Agents/Ticket/GetTicketMessageWithEmbeddedData openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - TicketAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Ticket/GetTicketMessageWithEmbeddedData: post: tags: - Ticket_Agent summary: Get Ticket Message With Embedded Data description: "Get a ticket message entity with posibillity to change embedded images to be represented with inline data within the HTML body.\n\nIf using inline data, be sure not to save this back to the database.\r\nNsApiSlow threshold: 2000 ms." operationId: v1TicketAgent_GetTicketMessageWithEmbeddedData parameters: - name: $select in: query description: >- 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. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest description: Id, EmbedImages required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.TicketMessageEntity text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.TicketMessageEntity application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.TicketMessageEntity text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.TicketMessageEntity application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.TicketMessageEntity application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.TicketMessageEntity security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetTicketMessageWithEmbeddedDataRequest: description: >- GetTicketMessageWithEmbeddedData: Get a ticket message entity with posibillity to change embedded images to be represented with inline data within the HTML body. If using inline data, be sure not to save this back to the database. type: object properties: Id: format: int32 type: integer EmbedImages: enum: - Link - Inline type: string SuperOffice.CRM.Services.TicketMessageEntity: description: "The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request).\r\n\r\nCarrier object for TicketMessageEntity.\r\nServices for the TicketMessageEntity Carrier is available from the Ticket Agent." type: object properties: EjMessageId: format: int32 description: The primary key (auto-incremented) type: integer Ticket: $ref: '#/components/schemas/SuperOffice.CRM.Services.Ticket' CreatedAt: format: date-time description: When the message was posted. type: string CreatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Author: description: >- A string representing the author of the message. Could be a user's name, or a persons email address. type: string Slevel: description: The securitylevel of the message. enum: - Unknown - Internal - External type: string Type: description: The type of the message (plaintext/html). enum: - Unknown - Plain - Html type: string MessageId: description: >- The Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets. type: string TimeSpent: format: int32 description: The time spent (minutes) for this message. type: integer Body: description: The textbody for the message. type: string HtmlBody: description: The html body for the message (if any). type: string EmailHeader: description: The email header is saved in this field as raw text type: string DebugInfo: description: The debug info for the message. type: string MailSorter: description: >- The name of the mail sorter used when the email was imported. Note: We must use name instead of id since the id's change every time one changes the mail sorter. :-0 type: string MessageCategory: description: Defines what kind of message this is. enum: - Message - Bounce - OutboxFailed type: string Person: $ref: '#/components/schemas/SuperOffice.CRM.Services.Person' SearchTitle: description: >- A copy of the title of the ticket, for search optimisation and simpler reporting. type: string MessageHeaders: description: >- Contains the message headers, like To, Cc, Bcc information, or custom headers type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessageHeader' Important: description: If this message is important or not. type: boolean Language: description: The language this message is in, based on some kind of analysis type: string Sentiment: format: int32 description: >- Sentiment index, 100 = completely happy; -100 = suicidally unhappy; 0 = no idea type: integer SentimentConfidence: format: int32 description: Confidence of sentiment index, 0 = no idea, 100 = completely sure type: integer Badge: description: Badge to explicitly determine how a message was generated enum: - Unknown - Reply - Forward - Comment - Incoming - Outgoing type: string AttachmentsInfo: description: Message attachments information type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.AttachmentEntity' ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.TicketMessageEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.TicketMessageEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Ticket: description: "The ticket carrier is used for representing a service request.\r\n\r\nCarrier object for Ticket.\r\nServices for the Ticket Carrier is available from the Ticket Agent." type: object properties: TicketId: format: int32 description: The primary key (auto-incremented) type: integer Title: description: The title of the ticket. type: string CreatedAt: format: date-time description: When the ticket was created. type: string LastChanged: format: date-time description: The last time the ticket was modified. type: string ReadByOwner: format: date-time description: The datetime for when the ticket last was read by the owner. type: string ReadByCustomer: format: date-time description: The datetime for when the ticket was read by the customer. type: string FirstReadByUser: format: date-time description: The datetime for when the ticket first was read by a user. type: string Activate: format: date-time description: When the ticket should be activated, if it is postponed. type: string ClosedAt: format: date-time description: When the ticket was closed. type: string RepliedAt: format: date-time description: >- The datetime for when the ticket was replied to. I.e. the first external message added to the ticket. type: string AlertTimeout: format: date-time description: >- The datetime for when the ticket should jump to the next alert_level. type: string Deadline: format: date-time description: Deadline for ticket. type: string CreatedBy: format: int32 description: >- The id of the user who created the ticket. 1 (system user) if the ticket was created externally type: integer CreatedByName: description: Initials, also login name, possibly database user name type: string Author: description: >- A string representing the author of the ticket (same as author of first message). type: string OwnedBy: format: int32 description: >- The id of the user who owns the ticket. 1 (system user) if the ticket is unassigned. type: integer OwnedByName: description: Initials, also login name, possibly database user name type: string Category: format: int32 description: The id of the category a ticket is in. type: integer CategoryName: description: The (short) name of this category. E.g. 'support'. type: string CategoryFullname: description: >- The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'. type: string Slevel: description: The securitylevel of the ticket. enum: - Unknown - Internal - External type: string Priority: format: int32 description: The reference to the ticket_priority table. type: integer PriorityName: description: The name of the priority. type: string BaseStatus: description: The status of the ticket. I.e. active/closed/postponed/deleted enum: - Unknown - Active - Closed - Postponed - Deleted - Merged - Spam - PostponedSpecific - Postponed1Hour - Postponed2Hours - Postponed3Hours - Postponed4Hours - PostponedDay - PostponedWeek - PostponedMonth type: string TicketStatus: format: int32 description: User defined ticket status type: integer TicketStatusDisplayValue: description: Get the display name of the ticket status. type: string Origin: description: What is the origin of this ticket enum: - Unknown - Email - SMS - Fax - Phone - Facebook - Twitter - Internal - CustomerCentre - EMarketing - AutoGenerated - Chat - Form - API - Flow type: string CustId: format: int32 description: >- The reference to the customer. NULL or -1 if ticket is not connected to customer. type: integer PersonFirstname: description: First name type: string PersonMiddleName: description: Middle name or 'van' etc. type: string PersonLastname: description: Last name type: string PersonFullname: description: Get the full name for the primary person (customer) type: string AlertLevel: format: int32 description: >- The alert level for the ticket. Matches the level value of the ticket_alert table. type: integer ConnectId: format: int32 description: >- If a ticket is connected to another ticket, this field is set to the id of the 'master' ticket. type: integer ReadStatus: description: Whether the owner has read the ticket or not (red, yellow, green). enum: - Unknown - Green - Yellow - Red type: string TimeToReply: format: int32 description: >- The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority's timeframe. type: integer RealTimeToReply: format: int32 description: Same as time_to_reply, but not calculated based on priority. type: integer TimeToClose: format: int32 description: >- The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority's timeframe. type: integer RealTimeToClose: format: int32 description: Same as time_to_close, but not calculated based on priority. type: integer TimeSpentInternally: format: int32 description: >- The total time (seconds) within the priority's office hours the ticket has been in an open status (configurable), not including current state type: integer TimeSpentExternally: format: int32 description: >- The total time (seconds) within the priority's office hours the ticket has been in a external waiting status (configurable), not including current state type: integer TimeSpentQueue: format: int32 description: >- The total time (seconds) within the priority's office hours the ticket has been in a queue status, not including current state type: integer RealTimeSpentInternally: format: int32 description: >- The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state type: integer RealTimeSpentExternally: format: int32 description: >- The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state type: integer RealTimeSpentQueue: format: int32 description: >- The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state type: integer TimeSpent: format: int32 description: >- The total time (minutes). Aggregated time spent from ticket's messages. Read-only for external use. type: integer HasAttachment: description: Boolean indicating if this ticket has one or more attachments. type: boolean NumReplies: format: int32 description: The number of replies (messages) to the customer for this request. type: integer NumMessages: format: int32 description: The total number of messages for this request. type: integer FromAddress: description: The from-address used when this ticket got created, e.g. by email type: string ContactId: format: int32 description: >- The company of the person in the cust_id field, if that person belongs to a company type: integer ContactName: description: The name of the connected contact type: string OwnedByAssociateId: format: int32 description: The associate id of the owner of the ticket. type: integer Language: description: The language of the first external message type: string Sentiment: format: int32 description: The sentiment index of the last external message type: integer SentimentConfidence: format: int32 description: The sentiment confidence of the last external message type: integer SaleId: format: int32 description: Reference to sale table type: integer ProjectId: format: int32 description: Reference to project table type: integer SaleHeading: description: The heading of the connected sale type: string ProjectName: description: The name of the connected project type: string FormSubmissionId: format: int32 description: >- If this ticket was created from a form submission, this field will point to that record type: integer TicketTypeId: format: int32 description: The id of the Request Type type: integer TicketTypeName: description: The name of the Request Type type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\nUse MDO List name \"person\" to get list items." type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Person: description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the Person Agent." type: object properties: Position: description: >- The position. This is a predefined SuperOffice value, different from Title type: string PersonId: format: int32 description: Primary key type: integer Mrmrs: description: e.g. Mrs sex_title type: string Firstname: description: First name type: string Lastname: description: Last name type: string MiddleName: description: Middle name or 'van' etc. type: string Title: description: Title type: string Description: description: Info text/description on person. type: string Email: description: First email on contact person. type: string FullName: description: >- Get the persons full name (internal name used in clients for employees). type: string DirectPhone: description: Returns the direct phone that belong to the contact person. type: string FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string CountryId: format: int32 description: Country type: integer ContactId: format: int32 description: Owning contact ID type: integer ContactName: description: The persons company name type: string Retired: format: int32 description: >- 1 = the user is retired and should have no rights, not appear in lists, etc. type: integer Rank: format: int32 description: Display sort sequence for default sort order type: integer ActiveInterests: format: int32 description: >- Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true type: integer ContactDepartment: description: The persons contact department type: string ContactCountryId: format: int32 description: The persons contact country id type: integer ContactOrgNr: description: The persons contact organization number type: string FaxPhone: description: Returns the fax phone that belong to the contact person. type: string MobilePhone: description: Returns the mobile phone that belong to the contact person. type: string ContactPhone: description: Returns the direct phone that belong to the persons contact. type: string AssociateName: description: Name of the person's owner type: string AssociateId: format: int32 description: Id of the item's owner (Associate id) type: integer UsePersonAddress: description: If 1, use person's address for mailing instead of company address type: boolean ContactFax: description: Actual phone number as eneterd by the user type: string Kanafname: description: Kana first name, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post3: description: Postal address, used in Japanese versions only type: string EmailName: description: E-mail description type: string ContactFullName: description: Company full name + department type: string ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer TicketPriorityId: format: int32 description: Ticket priority ID type: integer SupportLanguageId: format: int32 description: Support priority ID type: integer SupportAssociateId: format: int32 description: Our support contact for this person type: integer CategoryName: description: The category list item name type: string PersonNumber: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.TicketMessageHeader: description: "Contains information about a header connected to a ticket message\r\n\r\nCarrier object for TicketMessageHeader." type: object properties: Id: format: int32 description: Id type: integer Name: description: >- The name of the header. This can for example be To, Cc or other custom headers that is set up in Service type: string Value: description: >- The value of the header. Can for example be an email address, or a custom header extracted from emails type: string StdItem: description: >- If this has a value, it indicates that a standard header text from the language database should be used - and witch one to use enum: - None - Forward - UnnamedAttachmentBlocked - NoAutoReply - SentAutoReplyToCustomersA - SentAutoReplyToCustomersB - CustomerReadFAQ - ReplyTemplate type: string StdItemCol: description: >- If this is 1, concatenate the standard item text with header name field, if 2 use header value field instead. If this col is 0, use the empty field - preferably the value column. enum: - None - Name - Value type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.AttachmentEntity: description: "The Attachment carrier represent meta data for a Service attachment\r\n\r\nCarrier object for AttachmentEntity.\r\nServices for the AttachmentEntity Carrier is available from the Ticket Agent." type: object properties: AttachmentId: format: int32 description: The primary key (auto-incremented) type: integer Name: description: The filename for the attachment. type: string ContentType: description: >- The content type for the attachment (e.g. 'applaction/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'). type: string AttSize: format: int32 description: The size (in bytes) for the attachment. type: integer InlineImage: description: True if this attachment is inlined in the html_body. type: boolean ContentId: description: The content_id of this attachment, used for inline images type: string AuthKey: description: The key used for authenticating access to this attachment. type: string IsSafeFileExtension: description: Is file considered to be safe (based on extension and settings) type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [Http Get Get Ticket Message With Embedded Data](/en/api/reference/restful/rest/ticketmessage/http-get-get-ticket-message-with-embedded-data.md) - [SuperOffice.WebApi.Data.Ticket GetTicketMessageWithEmbeddedDataRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Ticket_GetTicketMessageWithEmbeddedDataRequest.md) - [SuperOffice.WebApi.Agents.TicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.TicketAgent.md) - [SuperOffice.WebApi.Agents.ITicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ITicketAgent.md) - [NSTicketMessage](/en/automation/crmscript/reference/CRMScript.NetServer.NSTicketMessage.md) - [Get Ticket Message](/en/api/reference/restful/agent/ticket_agent/get-ticket-message.md)