Service Web Service

Service

Click here for a complete list of operations.

SendSMSv2

Create a new 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.
phoneSubscribers: An array of string contains the phone number added to this email campaign.
category: An array of string contains the names of categories added to this email campaign.
isShortenLink: Whether to shorten the link.
isFilterOptout: Whether to filter Hong Kong Do-Not-Call list.
return campaignID.

Test

The test form is only available for methods with primitive types as parameters.

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/SendSMSv2"

<?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>
    <SendSMSv2 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>
      <phoneSubscribers>
        <string>string</string>
        <string>string</string>
      </phoneSubscribers>
      <category>
        <string>string</string>
        <string>string</string>
      </category>
      <isShortenLink>boolean</isShortenLink>
      <isFilterOptout>boolean</isFilterOptout>
    </SendSMSv2>
  </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>
    <SendSMSv2Response xmlns="http://service.reasonablespread.com/">
      <SendSMSv2Result>int</SendSMSv2Result>
    </SendSMSv2Response>
  </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>
    <SendSMSv2 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>
      <phoneSubscribers>
        <string>string</string>
        <string>string</string>
      </phoneSubscribers>
      <category>
        <string>string</string>
        <string>string</string>
      </category>
      <isShortenLink>boolean</isShortenLink>
      <isFilterOptout>boolean</isFilterOptout>
    </SendSMSv2>
  </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>
    <SendSMSv2Response xmlns="http://service.reasonablespread.com/">
      <SendSMSv2Result>int</SendSMSv2Result>
    </SendSMSv2Response>
  </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/SendSMSv2?loginEmail=string&APIKey=string&SMSContent=string&sender=string&schedule=string&campaignStatus=string&phoneSubscribers=string&phoneSubscribers=string&category=string&category=string&isShortenLink=string&isFilterOptout=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"?>
<int xmlns="http://service.reasonablespread.com/">int</int>

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/SendSMSv2 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&phoneSubscribers=string&phoneSubscribers=string&category=string&category=string&isShortenLink=string&isFilterOptout=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

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