Returned messaging information

The ReturnValue property returned by GetList is an iterator containing the requested messaging information. Each item (object) in the iterator corresponds to one message, that is, each item contains the data and metadata of a specific message.

Table: ReturnValue properties for messaging information

Property

Type

Notes

<item>.MessageType

string

Possible values:

  • "SMS"

  • "MMS"

  • "unknown"

The Messaging Service only supports SMS and MMS. Other types of messages are unknown.

<item>.Sender

string

 

<item>.Subject

string

Since SMS does not support subject, this property contains the first few characters of BodyText.

<item>.Time

object

 

<item>.Priority

string

Possible values:

  • "Low"

  • "Medium"

  • "High"

<item>.Attachment

boolean

 

<item>.Unread

boolean

 

<item>.MessageId

number

 

<item>.BodyText

string

 

<item>.To

array of strings

 

<item>.Cc

array of strings

 

<item>.Bcc

array of strings

 

<item>.AttachmentList

array of objects

Each object in the array contains the properties specified below.

The first attachment is specified in AttachmentList[0].

<item>.AttachmentList[].FileName

string

This property is only valid for MMS. SMS does not support attachments.

<item>.AttachmentList[].FileHandle

string

 

<item>.AttachmentList[].MimeType

string

 

<item>.AttachmentList[].FileSize

number