CMS Web Services - v4.0.6532.13712 [cms-a]

<back to all web services

MessageListQuery

Returns a list of messages and message details based on the query parameters (Default: Messages seen in the last 24 hours)

The following routes are available for this service:
POST,GET/message/list/query
MessageListQuery Parameters:
NameParameterData TypeRequiredDescription
QueryTypebodyMessageQueryTypeNoType of query (one of: Action,Addressee,Cms,Gateway,MessageId,Sender,Source,Subject)
QueryArgumentbodystringNoParameter value for selected query type (required when query type specified)
HistoryHoursbodyintNoNumber of hours of history to include (default: 24)
RecordLimitbodyintNoLimit number of records returned (default: 1000)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageListQueryResponse Parameters:
NameParameterData TypeRequiredDescription
MessageListformList<MessageListQueryRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MessageListQueryRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
MessageIdformstringNo
SizeformintNo
AttachmentsformintNo
ActionformstringNo
SourceformstringNo
CmsformstringNo
GatewayformstringNo
SenderformstringNo
SubjectformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /message/list/query HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MessageListQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <HistoryHours>0</HistoryHours>
  <QueryArgument>String</QueryArgument>
  <QueryType>None</QueryType>
  <RecordLimit>0</RecordLimit>
</MessageListQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageListQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MessageList>
    <MessageListQueryRecord>
      <Action>String</Action>
      <Attachments>0</Attachments>
      <Cms>String</Cms>
      <Gateway>String</Gateway>
      <MessageId>String</MessageId>
      <Sender>String</Sender>
      <Size>0</Size>
      <Source>String</Source>
      <Subject>String</Subject>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </MessageListQueryRecord>
  </MessageList>
</MessageListQueryResponse>