| 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. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type MessageLogQueryResponse() =
///<summary>
///The message log id
///</summary>
[<ApiMember(Description="The message log id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The booking id for the message (if connected to a booking).
///</summary>
[<ApiMember(Description="The booking id for the message (if connected to a booking).")>]
member val BookingId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The message receiver. Either a email or a mobile phone number.
///</summary>
[<ApiMember(Description="The message receiver. Either a email or a mobile phone number.")>]
member val Receiver:String = null with get,set
///<summary>
///Message Title.
///</summary>
[<ApiMember(Description="Message Title.")>]
member val MessageTitle:String = null with get,set
///<summary>
///Message Storage Url.
///</summary>
[<ApiMember(Description="Message Storage Url.")>]
member val StorageUrl:String = null with get,set
///<summary>
///Message Body.
///</summary>
[<ApiMember(Description="Message Body.")>]
member val MessageBody:String = null with get,set
///<summary>
///When message was created.
///</summary>
[<ApiMember(Description="When message was created.")>]
member val Created:DateTime = new DateTime() with get,set
///<summary>
///When the message will be sent.
///</summary>
[<ApiMember(Description="When the message will be sent.")>]
member val ToSendDate:DateTime = new DateTime() with get,set
///<summary>
///When the message was sent.
///</summary>
[<ApiMember(Description="When the message was sent.")>]
member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///If Message is sent
///</summary>
[<ApiMember(Description="If Message is sent")>]
member val Sent:Boolean = new Boolean() with get,set
///<summary>
///Number of retries to send the message
///</summary>
[<ApiMember(Description="Number of retries to send the message")>]
member val MessageRetries:Int32 = new Int32() with get,set
///<summary>
///Send Method. 1 = Email, 2 = SMS
///</summary>
[<ApiMember(Description="Send Method. 1 = Email, 2 = SMS")>]
member val SendMethodId:Int32 = new Int32() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type SendSMS() =
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The message receiver phone number (valid mobile number).
///</summary>
[<ApiMember(Description="The message receiver phone number (valid mobile number).")>]
member val Receiver:String = null with get,set
///<summary>
///Message Body.
///</summary>
[<ApiMember(Description="Message Body.")>]
member val MessageBody:String = null with get,set
///<summary>
///When the message will be sent.
///</summary>
[<ApiMember(Description="When the message will be sent.")>]
member val ToSendDate:DateTime = new DateTime() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Receiver":"String","MessageBody":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}