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

<back to all web services

MessageSendText

Sends a simple text message (attachments possible). If successfully posted the message ID is returned in the response.

The following routes are available for this service:
POST,GET/message/send/text
MessageSendText Parameters:
NameParameterData TypeRequiredDescription
MessageIdbodystringNoThe ID of the message. One will be created if not provided
SenderbodystringYesEmail address of sender
SubjectbodystringYesMessage subject
ToAddressesbodyList<string>YesOne or more recipient email addresses
CcAddressesbodyList<string>NoZero or more recipient cc email addresses
BodybodystringNoBody of the message
AttachmentsbodyList<Attachment>NoZero of more attachment records
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
Attachment Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
Imageformbyte[]No
MessageSendTextResponse 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/text HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MessageId: String,
	Sender: String,
	Subject: String,
	ToAddresses: 
	[
		String
	],
	CcAddresses: 
	[
		String
	],
	Body: String,
	Attachments: 
	[
		{
			FileName: String,
			Image: AA==
		}
	],
	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
		}
	}
}