VT_API Web Service

VT_API

Click here for a complete list of operations.

SendSMSMessages

Sends an SMS text message to a number of clients or mobile numbers, using the VETtrak SMS service

Test

The test form is only available for requests from the local machine.

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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.ozsoft.com.au/VETtrak/api/complete/SendSMSMessages"

<?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>
    <SendSMSMessages xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <messageContent>string</messageContent>
      <sender>string</sender>
      <smsRecipients>
        <TSMSRecipient>
          <ClientCode>string</ClientCode>
          <MobilePhone>string</MobilePhone>
        </TSMSRecipient>
        <TSMSRecipient>
          <ClientCode>string</ClientCode>
          <MobilePhone>string</MobilePhone>
        </TSMSRecipient>
      </smsRecipients>
      <isMarketing>boolean</isMarketing>
      <providerId>string</providerId>
      <acceptReplies>boolean</acceptReplies>
      <scheduleDate>dateTime</scheduleDate>
    </SendSMSMessages>
  </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>
    <SendSMSMessagesResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SendSMSMessagesResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <SmsSent>int</SmsSent>
        <SmsBalance>int</SmsBalance>
        <SMSResultList>
          <TSMSResult>
            <ClientCode>string</ClientCode>
            <MobilePhone>string</MobilePhone>
            <Status>int</Status>
          </TSMSResult>
          <TSMSResult>
            <ClientCode>string</ClientCode>
            <MobilePhone>string</MobilePhone>
            <Status>int</Status>
          </TSMSResult>
        </SMSResultList>
      </SendSMSMessagesResult>
    </SendSMSMessagesResponse>
  </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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.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>
    <SendSMSMessages xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <messageContent>string</messageContent>
      <sender>string</sender>
      <smsRecipients>
        <TSMSRecipient>
          <ClientCode>string</ClientCode>
          <MobilePhone>string</MobilePhone>
        </TSMSRecipient>
        <TSMSRecipient>
          <ClientCode>string</ClientCode>
          <MobilePhone>string</MobilePhone>
        </TSMSRecipient>
      </smsRecipients>
      <isMarketing>boolean</isMarketing>
      <providerId>string</providerId>
      <acceptReplies>boolean</acceptReplies>
      <scheduleDate>dateTime</scheduleDate>
    </SendSMSMessages>
  </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>
    <SendSMSMessagesResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SendSMSMessagesResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <SmsSent>int</SmsSent>
        <SmsBalance>int</SmsBalance>
        <SMSResultList>
          <TSMSResult>
            <ClientCode>string</ClientCode>
            <MobilePhone>string</MobilePhone>
            <Status>int</Status>
          </TSMSResult>
          <TSMSResult>
            <ClientCode>string</ClientCode>
            <MobilePhone>string</MobilePhone>
            <Status>int</Status>
          </TSMSResult>
        </SMSResultList>
      </SendSMSMessagesResult>
    </SendSMSMessagesResponse>
  </soap12:Body>
</soap12:Envelope>