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.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class MessageLogQueryResponse
    {
        ///<summary>
        ///The message log id
        ///</summary>
        [ApiMember(Description="The message log id")]
        public virtual int Id { 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).")]
        public virtual int? BookingId { 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.")]
        public virtual string Receiver { get; set; }

        ///<summary>
        ///Message Title.
        ///</summary>
        [ApiMember(Description="Message Title.")]
        public virtual string MessageTitle { get; set; }

        ///<summary>
        ///Message Storage Url.
        ///</summary>
        [ApiMember(Description="Message Storage Url.")]
        public virtual string StorageUrl { get; set; }

        ///<summary>
        ///Message Body.
        ///</summary>
        [ApiMember(Description="Message Body.")]
        public virtual string MessageBody { get; set; }

        ///<summary>
        ///When message was created.
        ///</summary>
        [ApiMember(Description="When message was created.")]
        public virtual DateTime Created { get; set; }

        ///<summary>
        ///When the message will be sent.
        ///</summary>
        [ApiMember(Description="When the message will be sent.")]
        public virtual DateTime ToSendDate { get; set; }

        ///<summary>
        ///When the message was sent.
        ///</summary>
        [ApiMember(Description="When the message was sent.")]
        public virtual DateTime? SentDate { get; set; }

        ///<summary>
        ///If Message is sent
        ///</summary>
        [ApiMember(Description="If Message is sent")]
        public virtual bool Sent { get; set; }

        ///<summary>
        ///Number of retries to send the message
        ///</summary>
        [ApiMember(Description="Number of retries to send the message")]
        public virtual int MessageRetries { get; set; }

        ///<summary>
        ///Send Method. 1 = Email, 2 = SMS
        ///</summary>
        [ApiMember(Description="Send Method. 1 = Email, 2 = SMS")]
        public virtual int SendMethodId { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class SendSMS
        : ICompany
    {
        ///<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.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The message receiver phone number (valid mobile number).
        ///</summary>
        [ApiMember(Description="The message receiver phone number (valid mobile number).")]
        public virtual string Receiver { get; set; }

        ///<summary>
        ///Message Body.
        ///</summary>
        [ApiMember(Description="Message Body.")]
        public virtual string MessageBody { get; set; }

        ///<summary>
        ///When the message will be sent.
        ///</summary>
        [ApiMember(Description="When the message will be sent.")]
        public virtual DateTime ToSendDate { get; set; }
    }

}

C# SendSMS DTOs

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

HTTP + XML

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

<SendSMS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <MessageBody>String</MessageBody>
  <Receiver>String</Receiver>
  <ToSendDate>0001-01-01T00:00:00</ToSendDate>
</SendSMS>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageLogQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <Created>0001-01-01T00:00:00</Created>
  <Id>0</Id>
  <MessageBody>String</MessageBody>
  <MessageRetries>0</MessageRetries>
  <MessageTitle>String</MessageTitle>
  <Receiver>String</Receiver>
  <SendMethodId>0</SendMethodId>
  <Sent>false</Sent>
  <SentDate>0001-01-01T00:00:00</SentDate>
  <StorageUrl>String</StorageUrl>
  <ToSendDate>0001-01-01T00:00:00</ToSendDate>
</MessageLogQueryResponse>