getMessage

Some tooltip text!

• 2 minutes to read

 • 2 minutes to read

Description

Retrieves a message. The ID required to call this message is retrieved from getTicket().

The example shows how to retrieve the message ID and iterate over the result.

Note

Only tickets available to the user logged in will be available.

In parameters

Parameter	Description
sessionKey	A valid session key
messageId	Internal ID of the message. This is the ID retrieved from getTicket().
messageFields	A list of fields that you wish to retrieve.

Valid messageFields fields:

• message.body
• message.id
• message.header
• message.md_body
• message.created_at
• message.author

Out parameters

Parameter	Description
errorCode	See list of codes
messageResult	Array of the results. See getTicket() for reference to the fields of this structure ResultStruct
attachmentInf	Array of information about attachments connected to this message. Each element contains the fields: attachmentId, attachmentName, and contentType

Example

string sessionKey;
customer.customerService custService = new customer.customerService();

if(custService.login("test","test", out sessionKey)=="0")
{
  string[] ticketFields = new string[1];
  ticketFields[0]="ticket.id";
  customer.ResultStruct[] ticketResult;
  string[] messageIds;
  if(custService.getTicket(sessionKey, "1208", ticketFields, out ticketResult, out messageIds)=="0")
  {
    string newValue ="";
    string[] messageFields = new string[2];
    messageFields[0] = "message.created_at";
    messageFields[1] = "message.body";
    customer.ResultStruct[] messageResult;
    customer.AttachmentInfoStruct[] attachmentInfo;
    if(custService.getMessage(sessionKey,
      messageIds[0],
      messageFields,
      out messageResult,
      out attachmentInfo)=="0")
    {
      foreach(customer.ResultStruct i in messageResult)
      {
        if(i.field == "message.body")
          newValue = i.value;
      }
    }
    textBox1.Text=newValue;
  }
  else
  {
    textBox1.Text = custService.getErrorMessage(sessionKey);
  }
}