BokaMera.API.Host

SendSMS

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
POST	/messages/sendsms	Send email to any mobile phone recipient	Send SMS to any mobile phone recipient.


export class MessageLogQueryResponse
{
    /** @description The message log id */
    // @ApiMember(Description="The message log id")
    public Id: number;

    /** @description The booking id for the message (if connected to a booking). */
    // @ApiMember(Description="The booking id for the message (if connected to a booking).")
    public BookingId?: number;

    /** @description The message receiver. Either a email or a mobile phone number. */
    // @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
    public Receiver: string;

    /** @description Message Title. */
    // @ApiMember(Description="Message Title.")
    public MessageTitle: string;

    /** @description Message Storage Url. */
    // @ApiMember(Description="Message Storage Url.")
    public StorageUrl: string;

    /** @description Message Body. */
    // @ApiMember(Description="Message Body.")
    public MessageBody: string;

    /** @description When message was created. */
    // @ApiMember(Description="When message was created.")
    public Created: string;

    /** @description When the message will be sent. */
    // @ApiMember(Description="When the message will be sent.")
    public ToSendDate: string;

    /** @description When the message was sent. */
    // @ApiMember(Description="When the message was sent.")
    public SentDate?: string;

    /** @description If Message is sent */
    // @ApiMember(Description="If Message is sent")
    public Sent: boolean;

    /** @description Number of retries to send the message */
    // @ApiMember(Description="Number of retries to send the message")
    public MessageRetries: number;

    /** @description Send Method. 1 = Email, 2 = SMS */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    public SendMethodId: number;

    public constructor(init?: Partial<MessageLogQueryResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class SendSMS implements ICompany
{
    /** @description 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.")
    public CompanyId?: string;

    /** @description The message receiver phone number (valid mobile number). */
    // @ApiMember(Description="The message receiver phone number (valid mobile number).")
    public Receiver: string;

    /** @description Message Body. */
    // @ApiMember(Description="Message Body.")
    public MessageBody: string;

    /** @description When the message will be sent. */
    // @ApiMember(Description="When the message will be sent.")
    public ToSendDate: string;

    public constructor(init?: Partial<SendSMS>) { (Object as any).assign(this, init); }
}

TypeScript SendSMS DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Receiver":"String","MessageBody":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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}