| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| POST | /messages/sendsms | Send email to any mobile phone recipient | Send SMS to any mobile phone recipient. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class SendSMS : ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
var CompanyId:UUID? = null
/**
* The message receiver phone number (valid mobile number).
*/
@ApiMember(Description="The message receiver phone number (valid mobile number).")
var Receiver:String? = null
/**
* Message Body.
*/
@ApiMember(Description="Message Body.")
var MessageBody:String? = null
/**
* When the message will be sent.
*/
@ApiMember(Description="When the message will be sent.")
var ToSendDate:Date? = null
}
open class MessageLogQueryResponse
{
/**
* The message log id
*/
@ApiMember(Description="The message log id")
var Id:Int? = null
/**
* The booking id for the message (if connected to a booking).
*/
@ApiMember(Description="The booking id for the message (if connected to a booking).")
var BookingId:Int? = null
/**
* The message receiver. Either a email or a mobile phone number.
*/
@ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
var Receiver:String? = null
/**
* Message Title.
*/
@ApiMember(Description="Message Title.")
var MessageTitle:String? = null
/**
* Message Storage Url.
*/
@ApiMember(Description="Message Storage Url.")
var StorageUrl:String? = null
/**
* Message Body.
*/
@ApiMember(Description="Message Body.")
var MessageBody:String? = null
/**
* When message was created.
*/
@ApiMember(Description="When message was created.")
var Created:Date? = null
/**
* When the message will be sent.
*/
@ApiMember(Description="When the message will be sent.")
var ToSendDate:Date? = null
/**
* When the message was sent.
*/
@ApiMember(Description="When the message was sent.")
var SentDate:Date? = null
/**
* If Message is sent
*/
@ApiMember(Description="If Message is sent")
var Sent:Boolean? = null
/**
* Number of retries to send the message
*/
@ApiMember(Description="Number of retries to send the message")
var MessageRetries:Int? = null
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
var SendMethodId:Int? = null
}
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
Host: api.bokamera.se
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
}