POST ASPSMSSendSMS?Userkey={Userkey}&Password={Password}

Sends out one SMS immediately or with deferred delivery time with advanced settings. Please check Properties of the abstract Datatype 'SMSData'

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Userkey

string

Required

Password

string

Required

Body Parameters

SMSData
NameDescriptionTypeAdditional information
Operation

string

None.

AffiliateID

integer

None.

BinaryFileData

string

None.

BinaryFileDataHex

string

None.

BinaryFileLocation

string

None.

DeferredDeliveryTime

date

None.

FlashingSMS

boolean

None.

IP

string

None.

LifeTime

integer

None.

MessageData

string

None.

Originator

string

None.

OriginatorUnlockCode

string

None.

ReplaceMessage

integer

None.

TimeZone

string

None.

URLBufferedMessageNotification

string

None.

URLDeliveryNotification

string

None.

URLNonDeliveryNotification

string

None.

XSer

string

None.

NotificationInquirySettingsFormat

integer

None.

NotificationInquirySettingsSeparator

string

None.

VCardName

string

None.

VCardPhoneNumber

string

None.

WAPPushSettingsURL

string

None.

WAPPushSettingsDescription

string

None.

Recipients

Collection of Recipient

None.

RecipientsEx

Collection of RecipientEx

None.

Request Formats

application/json, text/json

Sample:
{
  "Operation": "sample string 1",
  "AffiliateID": 1,
  "BinaryFileData": "sample string 2",
  "BinaryFileDataHex": "sample string 3",
  "BinaryFileLocation": "sample string 4",
  "DeferredDeliveryTime": "2019-10-14T11:01:07.1791856+02:00",
  "FlashingSMS": true,
  "IP": "sample string 5",
  "LifeTime": 1,
  "MessageData": "sample string 6",
  "Originator": "sample string 7",
  "OriginatorUnlockCode": "sample string 8",
  "ReplaceMessage": 9,
  "TimeZone": "sample string 10",
  "URLBufferedMessageNotification": "sample string 11",
  "URLDeliveryNotification": "sample string 12",
  "URLNonDeliveryNotification": "sample string 13",
  "XSer": "sample string 14",
  "NotificationInquirySettingsFormat": 1,
  "NotificationInquirySettingsSeparator": "sample string 15",
  "VCardName": "sample string 16",
  "VCardPhoneNumber": "sample string 17",
  "WAPPushSettingsURL": "sample string 18",
  "WAPPushSettingsDescription": "sample string 19",
  "Recipients": [
    {
      "PhoneNumber": "sample string 1",
      "TransactionReferenceNumber": "sample string 2"
    },
    {
      "PhoneNumber": "sample string 1",
      "TransactionReferenceNumber": "sample string 2"
    }
  ],
  "RecipientsEx": [
    {
      "PhoneNumber": "sample string 1",
      "TransactionReferenceNumber": "sample string 2",
      "MessageData": "sample string 3",
      "DeferredDeliveryTime": "2019-10-14T11:01:07.1791856+02:00"
    },
    {
      "PhoneNumber": "sample string 1",
      "TransactionReferenceNumber": "sample string 2",
      "MessageData": "sample string 3",
      "DeferredDeliveryTime": "2019-10-14T11:01:07.1791856+02:00"
    }
  ]
}

application/xml, text/xml

Sample:
<SMSData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASPSMSWebAPI.Models">
  <AffiliateID>1</AffiliateID>
  <BinaryFileData>sample string 2</BinaryFileData>
  <BinaryFileDataHex>sample string 3</BinaryFileDataHex>
  <BinaryFileLocation>sample string 4</BinaryFileLocation>
  <DeferredDeliveryTime>2019-10-14T11:01:07.1791856+02:00</DeferredDeliveryTime>
  <FlashingSMS>true</FlashingSMS>
  <IP>sample string 5</IP>
  <LifeTime>1</LifeTime>
  <MessageData>sample string 6</MessageData>
  <NotificationInquirySettingsFormat>1</NotificationInquirySettingsFormat>
  <NotificationInquirySettingsSeparator>sample string 15</NotificationInquirySettingsSeparator>
  <Operation>sample string 1</Operation>
  <Originator>sample string 7</Originator>
  <OriginatorUnlockCode>sample string 8</OriginatorUnlockCode>
  <Recipients>
    <Recipient>
      <PhoneNumber>sample string 1</PhoneNumber>
      <TransactionReferenceNumber>sample string 2</TransactionReferenceNumber>
    </Recipient>
    <Recipient>
      <PhoneNumber>sample string 1</PhoneNumber>
      <TransactionReferenceNumber>sample string 2</TransactionReferenceNumber>
    </Recipient>
  </Recipients>
  <RecipientsEx>
    <RecipientEx>
      <DeferredDeliveryTime>2019-10-14T11:01:07.1791856+02:00</DeferredDeliveryTime>
      <MessageData>sample string 3</MessageData>
      <PhoneNumber>sample string 1</PhoneNumber>
      <TransactionReferenceNumber>sample string 2</TransactionReferenceNumber>
    </RecipientEx>
    <RecipientEx>
      <DeferredDeliveryTime>2019-10-14T11:01:07.1791856+02:00</DeferredDeliveryTime>
      <MessageData>sample string 3</MessageData>
      <PhoneNumber>sample string 1</PhoneNumber>
      <TransactionReferenceNumber>sample string 2</TransactionReferenceNumber>
    </RecipientEx>
  </RecipientsEx>
  <ReplaceMessage>9</ReplaceMessage>
  <TimeZone>sample string 10</TimeZone>
  <URLBufferedMessageNotification>sample string 11</URLBufferedMessageNotification>
  <URLDeliveryNotification>sample string 12</URLDeliveryNotification>
  <URLNonDeliveryNotification>sample string 13</URLNonDeliveryNotification>
  <VCardName>sample string 16</VCardName>
  <VCardPhoneNumber>sample string 17</VCardPhoneNumber>
  <WAPPushSettingsDescription>sample string 19</WAPPushSettingsDescription>
  <WAPPushSettingsURL>sample string 18</WAPPushSettingsURL>
  <XSer>sample string 14</XSer>
</SMSData>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SMSData'.

Response Information

Resource Description

ASPSMSServerResult
NameDescriptionTypeAdditional information
ErrorCode

integer

None.

ErrorDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 1,
  "ErrorDescription": "sample string 2"
}

application/xml, text/xml

Sample:
<ASPSMSServerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASPSMSWebAPI.Models">
  <ErrorCode>1</ErrorCode>
  <ErrorDescription>sample string 2</ErrorDescription>
</ASPSMSServerResult>