MessageHeader Complex Type

The MessageHeader type contains information for routing the message, including the recipient, destination and other fields.

Syntax

<MessageHeader>
    <ID /> 
    <URI /> 
    <Category />
    <Sender />                     
    <Recipients>
        <!-- Array of -->  <MessageContact />      
    </Recipients>         
    <HasVoiceMemo />  
    <HasAttachments />
    <Created />  
</MessageHeader>

Complex Type Elements

Element Data type Description

ID

xs:string

A GUID identifying the message. The GUID is the same for the sender's and all recipient's copies of a given message.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Events: value provided by events.

URI

xs:anyURI

A unique identifier for this instance of the message. (The URIs of the sender's and each recipient's copy of a message are distinct.) This is the primary way of referencing specific messages in the Web Services API.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Events: value provided by events.

Category

MessageCategory

Category is used with the Read operation to specify the type of messages to be read. The following categories are available:

  • All: all messages in the account's message store.

  • Sent: messages originated by the account.

  • Inbox: messages received by the account.

  • New: inbox messages not previously read by the account.

  • Opened: inbox messages that have already been read.

Sender

MessageContact

The sender of the message. Only the URI field is used.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Events: value provided by events.

Recipients

Array of MessageContact

The recipients of the message. The Recipients array can contain zero or more MessageContact elements.

HasVoiceMemo

xs:boolean

Indicates a voice memo is attached.

HasAttachments

xs:boolean

Indicates there are one or more files attached.

Created

xs:dateTime

Indicates when the message was created. Specified as a UTC date-time with a precision of milliseconds.

The usage of this element depends on the context:

  • Read operation: value provided by operation.

  • Create operation: value ignored by operation.

  • Events: value provided by events.

See Also

Reference

GrooveMessages Web Service

Concepts

Accessing Groove Messages