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

<back to all web services

MessageSendSimple

Sends a plain text message to a single recipient. If successfully posted the message ID is returned in the response.

The following routes are available for this service:
POST,GET/message/send/simple
MessageSendSimple Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringNoThe ID of the message. One will be created if not provided
FrombodystringYesSender's callsign or email address
SubjectbodystringYesSubject of the message
TobodystringYesEmail address (or callsign) of recipient
BodybodystringYesBody of message
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageSendSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
MessageIdformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

HTTP + JSV

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

POST /message/send/simple HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MessageId: String,
	From: String,
	Subject: String,
	To: String,
	Body: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}