BokaMera.API.Host

TestSendMessageTemplate

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

The following routes are available for this service:
POST	/messages/templates/test	Test to send a message to a Email or Mobile phone recepient using SMS.

"use strict";
export class MessageLogQueryResponse {
    /** @param {{Id?:number,BookingId?:number,Receiver?:string,MessageTitle?:string,StorageUrl?:string,MessageBody?:string,Created?:string,ToSendDate?:string,SentDate?:string,Sent?:boolean,MessageRetries?:number,SendMethodId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The message log id */
    Id;
    /**
     * @type {?number}
     * @description The booking id for the message (if connected to a booking). */
    BookingId;
    /**
     * @type {string}
     * @description The message receiver. Either a email or a mobile phone number. */
    Receiver;
    /**
     * @type {string}
     * @description Message Title. */
    MessageTitle;
    /**
     * @type {string}
     * @description Message Storage Url. */
    StorageUrl;
    /**
     * @type {string}
     * @description Message Body. */
    MessageBody;
    /**
     * @type {string}
     * @description When message was created. */
    Created;
    /**
     * @type {string}
     * @description When the message will be sent. */
    ToSendDate;
    /**
     * @type {?string}
     * @description When the message was sent. */
    SentDate;
    /**
     * @type {boolean}
     * @description If Message is sent */
    Sent;
    /**
     * @type {number}
     * @description Number of retries to send the message */
    MessageRetries;
    /**
     * @type {number}
     * @description Send Method. 1 = Email, 2 = SMS */
    SendMethodId;
}
export class TestSendMessageTemplate {
    /** @param {{CompanyId?:string,Receiver?:string,Title?:string,Body?:string,TypeId?:number,Language?:string,Services?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided. */
    Receiver;
    /**
     * @type {string}
     * @description The message template title. */
    Title;
    /**
     * @type {string}
     * @description The newsletter template body. */
    Body;
    /**
     * @type {number}
     * @description The message type id. See GET /messages/templates/types  */
    TypeId;
    /**
     * @type {string}
     * @description Message template lanugage */
    Language;
    /**
     * @type {number[]}
     * @description The services that is connected to the message. If null it will be connected to all services. */
    Services;
}

JavaScript TestSendMessageTemplate DTOs

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

HTTP + CSV

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

POST /messages/templates/test HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Receiver":"String","Title":"String","Body":"String","TypeId":0,"Language":"String","Services":[0]}

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