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 recepient 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 | No | 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[] | No | 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 | No | The message receiver. Either a email or a mobile phone number. |
MessageTitle | form | string | No | Message Title. |
StorageUrl | form | string | No | Message Storage Url. |
MessageBody | form | string | No | 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<TestSendMessageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Language>String</Language>
<Receiver>String</Receiver>
<Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</Services>
<Title>String</Title>
<TypeId>0</TypeId>
</TestSendMessageTemplate>
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>