Default Ticket Message Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/TicketMessage/default");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/TicketMessage/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/TicketMessage/default",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/TicketMessage/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "EjMessageId": 123,
  "Ticket": {
    "TicketId": 123,
    "Title": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "LastChanged": "2023-11-07T05:31:56Z",
    "ReadByOwner": "2023-11-07T05:31:56Z",
    "ReadByCustomer": "2023-11-07T05:31:56Z",
    "FirstReadByUser": "2023-11-07T05:31:56Z",
    "Activate": "2023-11-07T05:31:56Z",
    "ClosedAt": "2023-11-07T05:31:56Z",
    "RepliedAt": "2023-11-07T05:31:56Z",
    "AlertTimeout": "2023-11-07T05:31:56Z",
    "Deadline": "2023-11-07T05:31:56Z",
    "CreatedBy": 123,
    "CreatedByName": "<string>",
    "Author": "<string>",
    "OwnedBy": 123,
    "OwnedByName": "<string>",
    "Category": 123,
    "CategoryName": "<string>",
    "CategoryFullname": "<string>",
    "Slevel": "Unknown",
    "Priority": 123,
    "PriorityName": "<string>",
    "BaseStatus": "Unknown",
    "TicketStatus": 123,
    "TicketStatusDisplayValue": "<string>",
    "Origin": "Unknown",
    "CustId": 123,
    "PersonFirstname": "<string>",
    "PersonMiddleName": "<string>",
    "PersonLastname": "<string>",
    "PersonFullname": "<string>",
    "AlertLevel": 123,
    "ConnectId": 123,
    "ReadStatus": "Unknown",
    "TimeToReply": 123,
    "RealTimeToReply": 123,
    "TimeToClose": 123,
    "RealTimeToClose": 123,
    "TimeSpentInternally": 123,
    "TimeSpentExternally": 123,
    "TimeSpentQueue": 123,
    "RealTimeSpentInternally": 123,
    "RealTimeSpentExternally": 123,
    "RealTimeSpentQueue": 123,
    "TimeSpent": 123,
    "HasAttachment": true,
    "NumReplies": 123,
    "NumMessages": 123,
    "FromAddress": "<string>",
    "ContactId": 123,
    "ContactName": "<string>",
    "OwnedByAssociateId": 123,
    "Language": "<string>",
    "Sentiment": 123,
    "SentimentConfidence": 123,
    "SaleId": 123,
    "ProjectId": 123,
    "SaleHeading": "<string>",
    "ProjectName": "<string>",
    "FormSubmissionId": 123,
    "TicketTypeId": 123,
    "TicketTypeName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Author": "<string>",
  "Slevel": "Unknown",
  "Type": "Unknown",
  "MessageId": "<string>",
  "TimeSpent": 123,
  "Body": "<string>",
  "HtmlBody": "<string>",
  "EmailHeader": "<string>",
  "DebugInfo": "<string>",
  "MailSorter": "<string>",
  "MessageCategory": "Message",
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SearchTitle": "<string>",
  "MessageHeaders": [
    {
      "Id": 123,
      "Name": "<string>",
      "Value": "<string>",
      "StdItem": "None",
      "StdItemCol": "None",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Important": true,
  "Language": "<string>",
  "Sentiment": 123,
  "SentimentConfidence": 123,
  "Badge": "Unknown",
  "AttachmentsInfo": [
    {
      "AttachmentId": 123,
      "Name": "<string>",
      "ContentType": "<string>",
      "AttSize": 123,
      "InlineImage": true,
      "ContentId": "<string>",
      "AuthKey": "<string>",
      "IsSafeFileExtension": true,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "ExtraFields": {},
  "CustomFields": {},
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Default Ticket Message Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/TicketMessage/default");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/TicketMessage/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/TicketMessage/default",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/TicketMessage/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "EjMessageId": 123,
  "Ticket": {
    "TicketId": 123,
    "Title": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "LastChanged": "2023-11-07T05:31:56Z",
    "ReadByOwner": "2023-11-07T05:31:56Z",
    "ReadByCustomer": "2023-11-07T05:31:56Z",
    "FirstReadByUser": "2023-11-07T05:31:56Z",
    "Activate": "2023-11-07T05:31:56Z",
    "ClosedAt": "2023-11-07T05:31:56Z",
    "RepliedAt": "2023-11-07T05:31:56Z",
    "AlertTimeout": "2023-11-07T05:31:56Z",
    "Deadline": "2023-11-07T05:31:56Z",
    "CreatedBy": 123,
    "CreatedByName": "<string>",
    "Author": "<string>",
    "OwnedBy": 123,
    "OwnedByName": "<string>",
    "Category": 123,
    "CategoryName": "<string>",
    "CategoryFullname": "<string>",
    "Slevel": "Unknown",
    "Priority": 123,
    "PriorityName": "<string>",
    "BaseStatus": "Unknown",
    "TicketStatus": 123,
    "TicketStatusDisplayValue": "<string>",
    "Origin": "Unknown",
    "CustId": 123,
    "PersonFirstname": "<string>",
    "PersonMiddleName": "<string>",
    "PersonLastname": "<string>",
    "PersonFullname": "<string>",
    "AlertLevel": 123,
    "ConnectId": 123,
    "ReadStatus": "Unknown",
    "TimeToReply": 123,
    "RealTimeToReply": 123,
    "TimeToClose": 123,
    "RealTimeToClose": 123,
    "TimeSpentInternally": 123,
    "TimeSpentExternally": 123,
    "TimeSpentQueue": 123,
    "RealTimeSpentInternally": 123,
    "RealTimeSpentExternally": 123,
    "RealTimeSpentQueue": 123,
    "TimeSpent": 123,
    "HasAttachment": true,
    "NumReplies": 123,
    "NumMessages": 123,
    "FromAddress": "<string>",
    "ContactId": 123,
    "ContactName": "<string>",
    "OwnedByAssociateId": 123,
    "Language": "<string>",
    "Sentiment": 123,
    "SentimentConfidence": 123,
    "SaleId": 123,
    "ProjectId": 123,
    "SaleHeading": "<string>",
    "ProjectName": "<string>",
    "FormSubmissionId": 123,
    "TicketTypeId": 123,
    "TicketTypeName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedAt": "2023-11-07T05:31:56Z",
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Author": "<string>",
  "Slevel": "Unknown",
  "Type": "Unknown",
  "MessageId": "<string>",
  "TimeSpent": 123,
  "Body": "<string>",
  "HtmlBody": "<string>",
  "EmailHeader": "<string>",
  "DebugInfo": "<string>",
  "MailSorter": "<string>",
  "MessageCategory": "Message",
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SearchTitle": "<string>",
  "MessageHeaders": [
    {
      "Id": 123,
      "Name": "<string>",
      "Value": "<string>",
      "StdItem": "None",
      "StdItemCol": "None",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Important": true,
  "Language": "<string>",
  "Sentiment": 123,
  "SentimentConfidence": 123,
  "Badge": "Unknown",
  "AttachmentsInfo": [
    {
      "AttachmentId": 123,
      "Name": "<string>",
      "ContentType": "<string>",
      "AttSize": 123,
      "InlineImage": true,
      "ContentId": "<string>",
      "AuthKey": "<string>",
      "IsSafeFileExtension": true,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "ExtraFields": {},
  "CustomFields": {},
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

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.

Response

The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request). Carrier object for TicketMessageEntity. Services for the TicketMessageEntity Carrier is available from the Ticket Agent.

EjMessageId

integer<int32>

The primary key (auto-incremented)

Ticket

object

The ticket carrier is used for representing a service request. Carrier object for Ticket. Services for the Ticket Carrier is available from the Ticket Agent.

Show child attributes

CreatedAt

string<date-time>

When the message was posted.

CreatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Author

string

A string representing the author of the message. Could be a user's name, or a persons email address.

Slevel

enum<string>

The securitylevel of the message.

Available options:

Unknown,

Internal,

External

Type

enum<string>

The type of the message (plaintext/html).

Available options:

Unknown,

Plain,

Html

MessageId

string

The Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets.

TimeSpent

integer<int32>

The time spent (minutes) for this message.

Body

string

The textbody for the message.

HtmlBody

string

The html body for the message (if any).

EmailHeader

string

The email header is saved in this field as raw text

DebugInfo

string

The debug info for the message.

MailSorter

string

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

MessageCategory

enum<string>

Defines what kind of message this is.

Available options:

Message,

Bounce,

OutboxFailed

Person

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

SearchTitle

string

A copy of the title of the ticket, for search optimisation and simpler reporting.

MessageHeaders

object[]

Contains the message headers, like To, Cc, Bcc information, or custom headers

Show child attributes

Important

boolean

If this message is important or not.

Language

string

The language this message is in, based on some kind of analysis

Sentiment

integer<int32>

Sentiment index, 100 = completely happy; -100 = suicidally unhappy; 0 = no idea

SentimentConfidence

integer<int32>

Confidence of sentiment index, 0 = no idea, 100 = completely sure

Badge

enum<string>

Badge to explicitly determine how a message was generated

Available options:

Unknown,

Reply,

Forward,

Comment,

Incoming,

Outgoing

AttachmentsInfo

object[]

Message attachments information

Show child attributes

ExtraFields

object

Deprecated: Use {SuperOffice.CRM.Services.TicketMessageEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Show child attributes

CustomFields

object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.TicketMessageEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes