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

<back to all web services

MessageGetDecoded

Gets a specific email message identified by MessageId. Returns the decoded message.

The following routes are available for this service:
POST,GET/message/get/decoded
MessageGetDecoded Parameters:
NameParameterData TypeRequiredDescription
AccountNamebodystringYesAccount callsign or callsign of requester
PasswordbodystringYesPassword for account
MessageIdbodystringYesThe ID of the message
MarkAsForwardedbodyboolNoMessage is marked as forwarded (delivered)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageGetDecodedResponse Parameters:
NameParameterData TypeRequiredDescription
MessageIdformstringNo
HeaderformstringNo
SenderformstringNo
SourceformstringNo
SubjectformstringNo
ToAddressesformList<string>No
CcAddressesformList<string>No
BodyformstringNo
AttachmentsformList<Attachment>No
ForwardedformboolNo
MimeformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Attachment Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
Imageformbyte[]No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /message/get/decoded HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AccountName":"String","Password":"String","MessageId":"String","MarkAsForwarded":false,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MessageId":"String","Header":"String","Sender":"String","Source":"String","Subject":"String","ToAddresses":["String"],"CcAddresses":["String"],"Body":"String","Attachments":[{"FileName":"String","Image":"AA=="}],"Forwarded":false,"Mime":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}