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

<back to all web services

MessageSend

Sends a message. If successfully posted the message ID is returned with the response.

The following routes are available for this service:
POST,GET/message/send
MessageSend Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringNoThe ID of the message. One will be created if not provided
MimebodystringYesThe full email message in mime format (headers and body)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageSendResponse Parameters:
NameParameterData TypeRequiredDescription
MessageIdformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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/send HTTP/1.1 
Host: perth.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"MessageId":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}