<back to all web services


Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
POST/messages/sendsmsSend email to any mobile phone recipientSend SMS to any mobile phone recipient.
SendSMS Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ReceiverbodystringNoThe message receiver phone number (valid mobile number).
MessageBodybodystringNoMessage Body.
ToSendDatebodyDateTimeNoWhen the message will be sent.
MessageLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message log id
BookingIdformint?NoThe booking id for the message (if connected to a booking).
ReceiverformstringNoThe message receiver. Either a email or a mobile phone number.
MessageTitleformstringNoMessage Title.
StorageUrlformstringNoMessage Storage Url.
MessageBodyformstringNoMessage Body.
CreatedformDateTimeNoWhen message was created.
ToSendDateformDateTimeNoWhen the message will be sent.
SentDateformDateTime?NoWhen the message was sent.
SentformboolNoIf Message is sent
MessageRetriesformintNoNumber of retries to send the message
SendMethodIdformintNoSend Method. 1 = Email, 2 = SMS

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


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

POST /messages/sendsms HTTP/1.1 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

	CompanyId: 00000000-0000-0000-0000-000000000000,
	Receiver: String,
	MessageBody: String
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

	Id: 0,
	BookingId: 0,
	Receiver: String,
	MessageTitle: String,
	StorageUrl: String,
	MessageBody: String,
	SentDate: "0001-01-01T00:00:00",
	Sent: False,
	MessageRetries: 0,
	SendMethodId: 0