POST example/api/SmsMessage

https://app.bwz.se/bedrock/example/api/SmsMessage

Creates a SmsMessage.

Request Information

URI Parameters

None.

Body Parameters

Sets the text content of the SmsMessage.

Name	Description	Type	Additional information
Name	Sets the name.	string	Required Valid name with max 256 characters
PublicationId	Sets the Publication the SmsMessage belongs to.	integer	Required
SenderName	Sets the name of the sender.	string	Required
DefaultCountryCode	Sets the default country code of the SmsMessage. Will be used for all recipients without country code in their mobile number.	integer	Required
ScheduledSendDate	Sets date and time when the SmsMessage will be sent.	date	None.
TextContent	Sets the text content of the SmsMessage.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "PublicationId": 2,
  "SenderName": "sample string 3",
  "DefaultCountryCode": 4,
  "ScheduledSendDate": "2024-12-23T06:20:09.8284293+01:00",
  "TextContent": "sample string 5"
}

application/xml, text/xml

Sample:

<CreateSmsMessageArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsMessage">
  <DefaultCountryCode>4</DefaultCountryCode>
  <Name>sample string 1</Name>
  <PublicationId>2</PublicationId>
  <ScheduledSendDate>2024-12-23T06:20:09.8284293+01:00</ScheduledSendDate>
  <SenderName>sample string 3</SenderName>
  <TextContent>sample string 5</TextContent>
</CreateSmsMessageArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The SmsMessageModel that has been created.

SmsMessageModel

Name	Description	Type	Additional information
Id	Id of the SmsMessage.	integer	None.
Name	Name of the SmsMessage.	string	None.
CreatedByUserId	Id of the User creating the SmsMessage.	integer	None.
MessageStatus	The MessageStatus of the SmsMessage.	MessageStatus	None.
CreationDate	Date and time when the SmsMessage was created.	date	None.
ModifiedDate	Date and time when the SmsMessage was last modified.	date	None.
PublicationId	Id the of Publication the SmsMessage belongs to.	integer	None.
SenderName	Sender name of the SmsMessage.	string	None.
DefaultCountryCode	Default country code of the SmsMessage. Will be used for all recipients without country code in their mobile number.	integer	None.
SmsContentId	Id of the Content holding the content of the SmsMessage.	integer	None.
ScheduledSendDate	Date and time when the SmsMessage will be sent.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "CreatedByUserId": 3,
  "MessageStatus": 0,
  "CreationDate": "2024-12-23T06:20:09.8284293+01:00",
  "ModifiedDate": "2024-12-23T06:20:09.8284293+01:00",
  "PublicationId": 6,
  "SenderName": "sample string 7",
  "DefaultCountryCode": 8,
  "SmsContentId": 1,
  "ScheduledSendDate": "2024-12-23T06:20:09.8284293+01:00"
}

application/xml, text/xml

Sample:

<SmsMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsMessage">
  <CreatedByUserId>3</CreatedByUserId>
  <CreationDate>2024-12-23T06:20:09.8284293+01:00</CreationDate>
  <DefaultCountryCode>8</DefaultCountryCode>
  <Id>1</Id>
  <MessageStatus>NotReadyToSend</MessageStatus>
  <ModifiedDate>2024-12-23T06:20:09.8284293+01:00</ModifiedDate>
  <Name>sample string 2</Name>
  <PublicationId>6</PublicationId>
  <ScheduledSendDate>2024-12-23T06:20:09.8284293+01:00</ScheduledSendDate>
  <SenderName>sample string 7</SenderName>
  <SmsContentId>1</SmsContentId>
</SmsMessageModel>