POST example/api/smsmessage/{smsMessageId}/sendsmsmessage

https://app.bwz.se/bedrock/example/api/smsmessage/{smsMessageId}/sendsmsmessage

Sends (or schedules) a SmsMessage.

Request Information

URI Parameters

Name	Description	Type	Additional information
smsMessageId	Id of the SmsMessage to send.	integer	Required

Body Parameters

If the mail message has recipient lists connected via the UI or API also send to them

SendSmsMessageArgs

Name	Description	Type	Additional information
SenderName	Sets the sender name of the SMS. If not set, SenderName of the SmsMessage will be used.	string	None.
DefaultCountryCode	Sets the default country code for the SMS. If not set, DefaultCountryCode of the SmsMessage will be used.	integer	None.
SendDate	Sets the from date and time the SMS will be sent.	date	None.
SmsRecipientListIds	IDs of the lists the SMS message will be sent to.	Collection of integer	None.
SingleRecipientMobileNumbers	Mobile numbers of single recipients the SMS message will be sent to.	Collection of string	None.
AlsoSendToAlreadyConnectedRecipientLists	If the mail message has recipient lists connected via the UI or API also send to them	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SenderName": "sample string 1",
  "DefaultCountryCode": 1,
  "SendDate": "2024-11-21T17:46:17.3230618+01:00",
  "SmsRecipientListIds": [
    1,
    2
  ],
  "SingleRecipientMobileNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "AlsoSendToAlreadyConnectedRecipientLists": true
}

application/xml, text/xml

Sample:

<SendSmsMessageArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsMessage">
  <AlsoSendToAlreadyConnectedRecipientLists>true</AlsoSendToAlreadyConnectedRecipientLists>
  <DefaultCountryCode>1</DefaultCountryCode>
  <SendDate>2024-11-21T17:46:17.3230618+01:00</SendDate>
  <SenderName>sample string 1</SenderName>
  <SingleRecipientMobileNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SingleRecipientMobileNumbers>
  <SmsRecipientListIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SmsRecipientListIds>
</SendSmsMessageArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The sent (or scheduled) SmsMessageModel.

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-11-21T17:46:17.3230618+01:00",
  "ModifiedDate": "2024-11-21T17:46:17.3230618+01:00",
  "PublicationId": 6,
  "SenderName": "sample string 7",
  "DefaultCountryCode": 8,
  "SmsContentId": 1,
  "ScheduledSendDate": "2024-11-21T17:46:17.3230618+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-11-21T17:46:17.3230618+01:00</CreationDate>
  <DefaultCountryCode>8</DefaultCountryCode>
  <Id>1</Id>
  <MessageStatus>NotReadyToSend</MessageStatus>
  <ModifiedDate>2024-11-21T17:46:17.3230618+01:00</ModifiedDate>
  <Name>sample string 2</Name>
  <PublicationId>6</PublicationId>
  <ScheduledSendDate>2024-11-21T17:46:17.3230618+01:00</ScheduledSendDate>
  <SenderName>sample string 7</SenderName>
  <SmsContentId>1</SmsContentId>
</SmsMessageModel>