Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

SendSmsToMailingList

Sends an SMS message to a specific mailinglist. Note! If there are not enough SMS credits on the account, the SMS will be sent as soon as the account has been refilled with enough SMS credits.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
strMailingListId:
strMessage:

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 /ExternalAPIService.asmx HTTP/1.1
Host: api.anpdm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.anpdm.com/SendSmsToMailingList"

<?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>
    <SendSmsToMailingList xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strMailingListId>string</strMailingListId>
      <strMessage>string</strMessage>
    </SendSmsToMailingList>
  </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>
    <SendSmsToMailingListResponse xmlns="http://api.anpdm.com/">
      <SendSmsToMailingListResult>
        <CreditCost>decimal</CreditCost>
        <TotalCredits>decimal</TotalCredits>
      </SendSmsToMailingListResult>
    </SendSmsToMailingListResponse>
  </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 /ExternalAPIService.asmx HTTP/1.1
Host: api.anpdm.com
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>
    <SendSmsToMailingList xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strMailingListId>string</strMailingListId>
      <strMessage>string</strMessage>
    </SendSmsToMailingList>
  </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>
    <SendSmsToMailingListResponse xmlns="http://api.anpdm.com/">
      <SendSmsToMailingListResult>
        <CreditCost>decimal</CreditCost>
        <TotalCredits>decimal</TotalCredits>
      </SendSmsToMailingListResult>
    </SendSmsToMailingListResponse>
  </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 /ExternalAPIService.asmx/SendSmsToMailingList?strUsername=string&strPassword=string&strMailingListId=string&strMessage=string HTTP/1.1
Host: api.anpdm.com

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

<?xml version="1.0" encoding="utf-8"?>
<SmsMassMessageResult xmlns="http://api.anpdm.com/">
  <CreditCost>decimal</CreditCost>
  <TotalCredits>decimal</TotalCredits>
</SmsMassMessageResult>

HTTP POST

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

POST /ExternalAPIService.asmx/SendSmsToMailingList HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&strMailingListId=string&strMessage=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SmsMassMessageResult xmlns="http://api.anpdm.com/">
  <CreditCost>decimal</CreditCost>
  <TotalCredits>decimal</TotalCredits>
</SmsMassMessageResult>