POST example/api/transactionsms/send

https://app.bwz.se/bedrock/example/api/transactionsms/send

Send a transaction sms with custom content

Request Information

URI Parameters

None.

Body Parameters

Tags/variables to be replace in the text content

Name	Description	Type	Additional information
Text	Gets or sets the text.	string	Required
FromNumber	The alpha number sender of the sms -	string	Required
DestinationNumber	The recipient number with country code	string	Required
MaxParts	Max number of parts a sms can concatenated with Use this property truncate long SMS The number of characters per part is different based on which character set that need to be used to transfer the data More info here https://www.world-text.com/docs/sms-length.php	integer	None.
DeliveryTimeoutHours	Number of hours the SMSC will try to deliver the SMS to the phone before timing out	integer	None.
ScheduledSendDate	Scheduled time to send the SMS	date	None.
TextContentTagModels	Tags/variables to be replace in the text content	Collection of TagModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Text": "sample string 1",
  "FromNumber": "sample string 2",
  "DestinationNumber": "sample string 3",
  "MaxParts": 1,
  "DeliveryTimeoutHours": 1,
  "ScheduledSendDate": "2024-11-24T01:24:22.2947397+01:00",
  "TextContentTagModels": [
    {
      "Name": "sample string 1",
      "Value": {}
    },
    {
      "Name": "sample string 1",
      "Value": {}
    }
  ]
}

application/xml, text/xml

Sample:

<SendTransactionSmsArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionsSms">
  <DeliveryTimeoutHours>1</DeliveryTimeoutHours>
  <DestinationNumber>sample string 3</DestinationNumber>
  <FromNumber>sample string 2</FromNumber>
  <MaxParts>1</MaxParts>
  <ScheduledSendDate>2024-11-24T01:24:22.2947397+01:00</ScheduledSendDate>
  <TextContentTagModels xmlns:d2p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionMail">
    <d2p1:TagModel>
      <Name>sample string 1</Name>
      <Value>System.Object</Value>
    </d2p1:TagModel>
    <d2p1:TagModel>
      <Name>sample string 1</Name>
      <Value>System.Object</Value>
    </d2p1:TagModel>
  </TextContentTagModels>
  <Text>sample string 1</Text>
</SendTransactionSmsArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A TransactionSmsModel

TransactionSmsModel

Name	Description	Type	Additional information
TransactionSmsId	Gets or sets the transaction SMS identifier.	integer	None.
DestinationNumber	Gets or sets the destination number.	string	None.
FromNumber	Gets or sets from number.	string	None.
MaxParts	Gets or sets the maximum parts.	integer	None.
ScheduledSendTime	Gets or sets the scheduled send time.	date	None.
Text	Gets or sets the text.	string	None.
DeliveryTimeoutHours	Gets or sets the delivery timeout hours.	integer	None.
CreationDate	Gets the date time the transaction sms was created	date	None.

Response Formats

application/json, text/json

Sample:

{
  "TransactionSmsId": 1,
  "DestinationNumber": "sample string 2",
  "FromNumber": "sample string 3",
  "MaxParts": 4,
  "ScheduledSendTime": "2024-11-24T01:24:22.2947397+01:00",
  "Text": "sample string 5",
  "DeliveryTimeoutHours": 6,
  "CreationDate": "2024-11-24T01:24:22.2947397+01:00"
}

application/xml, text/xml

Sample:

<TransactionSmsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionsSms">
  <CreationDate>2024-11-24T01:24:22.2947397+01:00</CreationDate>
  <DeliveryTimeoutHours>6</DeliveryTimeoutHours>
  <DestinationNumber>sample string 2</DestinationNumber>
  <FromNumber>sample string 3</FromNumber>
  <MaxParts>4</MaxParts>
  <ScheduledSendTime>2024-11-24T01:24:22.2947397+01:00</ScheduledSendTime>
  <Text>sample string 5</Text>
  <TransactionSmsId>1</TransactionSmsId>
</TransactionSmsModel>