Service


Click here for a complete list of operations.

SendPSMS

Create a new promotional sms campaign
Arguments:

loginEmail: Login Email of Spread.
APIKey: The APIKey of your Spread account which you can retrieve from your Spread account (My account=> Settings).
SMSContent: The content of SMS campaign.
sender:The sender of SMS campaign.
schedule: The date of when to establish the email campaign.
campaignStatus: The status of the email campaign.
category: An array of string contains the names of categories added to this email campaign.
isFilterOptOut: The value to confirm if filter the opt-out subscribers for this campaign. Please input 'true' or 'false'.
expiryTime: The expired time of message for this campaign.
sendPeriod: The send Period, e.g. 9:00-18:00.
isContinueNextSendPeriod: If the campaign does not finish within send period, would let the campaign continue to send it out in the next send period?
isShortenUrl: If shorten the URL. If yes, it will use less content and we can tracking if the subscriber clicks the URL.
return String that could be deserialized to JSON type. .

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
loginEmail:
APIKey:
SMSContent:
sender:
schedule:
campaignStatus:
category:
isFilterOptOut:
expiryTime:
sendPeriod:
isContinueNextSendPeriod:
isShortenUrl:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx HTTP/1.1
Host: service.towngas.marketing
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://service.reasonablespread.com/SendPSMS"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendPSMS xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <APIKey>string</APIKey>
      <SMSContent>string</SMSContent>
      <sender>string</sender>
      <schedule>dateTime</schedule>
      <campaignStatus>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</campaignStatus>
      <category>string</category>
      <isFilterOptOut>boolean</isFilterOptOut>
      <expiryTime>string</expiryTime>
      <sendPeriod>string</sendPeriod>
      <isContinueNextSendPeriod>boolean</isContinueNextSendPeriod>
      <isShortenUrl>boolean</isShortenUrl>
    </SendPSMS>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendPSMSResponse xmlns="http://service.reasonablespread.com/">
      <SendPSMSResult>string</SendPSMSResult>
    </SendPSMSResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx HTTP/1.1
Host: service.towngas.marketing
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendPSMS xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <APIKey>string</APIKey>
      <SMSContent>string</SMSContent>
      <sender>string</sender>
      <schedule>dateTime</schedule>
      <campaignStatus>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</campaignStatus>
      <category>string</category>
      <isFilterOptOut>boolean</isFilterOptOut>
      <expiryTime>string</expiryTime>
      <sendPeriod>string</sendPeriod>
      <isContinueNextSendPeriod>boolean</isContinueNextSendPeriod>
      <isShortenUrl>boolean</isShortenUrl>
    </SendPSMS>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendPSMSResponse xmlns="http://service.reasonablespread.com/">
      <SendPSMSResult>string</SendPSMSResult>
    </SendPSMSResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /service.asmx/SendPSMS?loginEmail=string&APIKey=string&SMSContent=string&sender=string&schedule=string&campaignStatus=string&category=string&isFilterOptOut=string&expiryTime=string&sendPeriod=string&isContinueNextSendPeriod=string&isShortenUrl=string HTTP/1.1
Host: service.towngas.marketing
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://service.reasonablespread.com/">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx/SendPSMS HTTP/1.1
Host: service.towngas.marketing
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginEmail=string&APIKey=string&SMSContent=string&sender=string&schedule=string&campaignStatus=string&category=string&isFilterOptOut=string&expiryTime=string&sendPeriod=string&isContinueNextSendPeriod=string&isShortenUrl=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://service.reasonablespread.com/">string</string>