| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| POST | /messages/templates/test | Test to send a message to a Email or Mobile phone recipient using SMS. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Receiver | body | string | Yes | 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. |
| Title | body | string | Yes | The message template title. |
| Body | body | string | Yes | The newsletter template body. |
| TypeId | body | int? | Yes | The message type id. See GET /messages/templates/types |
| Language | body | string | Yes | Message template lanugage |
| Services | body | int[] | Yes | The services that is connected to the message. If null it will be connected to all services. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The message log id |
| BookingId | form | int? | No | The booking id for the message (if connected to a booking). |
| Receiver | form | string | Yes | The message receiver. Either a email or a mobile phone number. |
| MessageTitle | form | string | Yes | Message Title. |
| StorageUrl | form | string | Yes | Message Storage Url. |
| MessageBody | form | string | Yes | Message Body. |
| Created | form | DateTime | No | When message was created. |
| ToSendDate | form | DateTime | No | When the message will be sent. |
| SentDate | form | DateTime? | No | When the message was sent. |
| Sent | form | bool | No | If Message is sent |
| MessageRetries | form | int | No | Number of retries to send the message |
| SendMethodId | form | int | No | Send Method. 1 = Email, 2 = SMS |
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/templates/test HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
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/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
}