inbox

Click here for a complete list of operations.

Read

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
user_id:
from:
to:
max_count:

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 /api/inbox.asmx HTTP/1.1
Host: www.smsguys.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.smsguys.co.za/api/Read"

<?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>
    <Read xmlns="http://www.smsguys.co.za/api">
      <user_id>string</user_id>
      <from>dateTime</from>
      <to>dateTime</to>
      <max_count>int</max_count>
    </Read>
  </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>
    <ReadResponse xmlns="http://www.smsguys.co.za/api">
      <ReadResult>
        <ReceivedMessage>
          <id>long</id>
          <sender>string</sender>
          <message>string</message>
          <short_code>string</short_code>
          <timestamp>dateTime</timestamp>
        </ReceivedMessage>
        <ReceivedMessage>
          <id>long</id>
          <sender>string</sender>
          <message>string</message>
          <short_code>string</short_code>
          <timestamp>dateTime</timestamp>
        </ReceivedMessage>
      </ReadResult>
    </ReadResponse>
  </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 /api/inbox.asmx HTTP/1.1
Host: www.smsguys.co.za
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>
    <Read xmlns="http://www.smsguys.co.za/api">
      <user_id>string</user_id>
      <from>dateTime</from>
      <to>dateTime</to>
      <max_count>int</max_count>
    </Read>
  </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>
    <ReadResponse xmlns="http://www.smsguys.co.za/api">
      <ReadResult>
        <ReceivedMessage>
          <id>long</id>
          <sender>string</sender>
          <message>string</message>
          <short_code>string</short_code>
          <timestamp>dateTime</timestamp>
        </ReceivedMessage>
        <ReceivedMessage>
          <id>long</id>
          <sender>string</sender>
          <message>string</message>
          <short_code>string</short_code>
          <timestamp>dateTime</timestamp>
        </ReceivedMessage>
      </ReadResult>
    </ReadResponse>
  </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 /api/inbox.asmx/Read?user_id=string&from=string&to=string&max_count=string HTTP/1.1
Host: www.smsguys.co.za

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfReceivedMessage xmlns="http://www.smsguys.co.za/api">
  <ReceivedMessage>
    <id>long</id>
    <sender>string</sender>
    <message>string</message>
    <short_code>string</short_code>
    <timestamp>dateTime</timestamp>
  </ReceivedMessage>
  <ReceivedMessage>
    <id>long</id>
    <sender>string</sender>
    <message>string</message>
    <short_code>string</short_code>
    <timestamp>dateTime</timestamp>
  </ReceivedMessage>
</ArrayOfReceivedMessage>

HTTP POST

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

POST /api/inbox.asmx/Read HTTP/1.1
Host: www.smsguys.co.za
Content-Type: application/x-www-form-urlencoded
Content-Length: length

user_id=string&from=string&to=string&max_count=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfReceivedMessage xmlns="http://www.smsguys.co.za/api">
  <ReceivedMessage>
    <id>long</id>
    <sender>string</sender>
    <message>string</message>
    <short_code>string</short_code>
    <timestamp>dateTime</timestamp>
  </ReceivedMessage>
  <ReceivedMessage>
    <id>long</id>
    <sender>string</sender>
    <message>string</message>
    <short_code>string</short_code>
    <timestamp>dateTime</timestamp>
  </ReceivedMessage>
</ArrayOfReceivedMessage>