Inbound Web Service

Inbound

Click here for a complete list of operations.

GetList2

Returns list of inbound fax details.

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 /inbound.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.interfax.net/GetList2"

<?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>
    <GetList2 xmlns="http://www.interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <QueryForm>
        <TransactionID>int</TransactionID>
        <UserID>string</UserID>
        <OnlyNewMessages>boolean</OnlyNewMessages>
        <RecieveTime>
          <Verb>string</Verb>
          <VerbData>string</VerbData>
        </RecieveTime>
      </QueryForm>
      <QueryControl>
        <MaxChunkSize>int</MaxChunkSize>
        <FromRecordNumber>int</FromRecordNumber>
      </QueryControl>
    </GetList2>
  </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>
    <GetList2Response xmlns="http://www.interfax.net">
      <GetList2Result>
        <MessageItems>
          <MessageItem2>
            <UserID>string</UserID>
            <MessageID>int</MessageID>
            <PhoneNumber>string</PhoneNumber>
            <RemoteCSID>string</RemoteCSID>
            <MessageStatus>int</MessageStatus>
            <Pages>int</Pages>
            <MessageSize>int</MessageSize>
            <MessageType>short</MessageType>
            <ReceiveTime>dateTime</ReceiveTime>
            <CallerID>string</CallerID>
            <MessageRecordingDuration>int</MessageRecordingDuration>
            <ImageStatus>string</ImageStatus>
            <NumOfEmails>int</NumOfEmails>
            <NumOfFailedEmails>int</NumOfFailedEmails>
          </MessageItem2>
          <MessageItem2>
            <UserID>string</UserID>
            <MessageID>int</MessageID>
            <PhoneNumber>string</PhoneNumber>
            <RemoteCSID>string</RemoteCSID>
            <MessageStatus>int</MessageStatus>
            <Pages>int</Pages>
            <MessageSize>int</MessageSize>
            <MessageType>short</MessageType>
            <ReceiveTime>dateTime</ReceiveTime>
            <CallerID>string</CallerID>
            <MessageRecordingDuration>int</MessageRecordingDuration>
            <ImageStatus>string</ImageStatus>
            <NumOfEmails>int</NumOfEmails>
            <NumOfFailedEmails>int</NumOfFailedEmails>
          </MessageItem2>
        </MessageItems>
        <ResultCode>int</ResultCode>
        <TotalTransactionsNum>int</TotalTransactionsNum>
      </GetList2Result>
    </GetList2Response>
  </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 /inbound.asmx HTTP/1.1
Host: ws.interfax.net
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>
    <GetList2 xmlns="http://www.interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <QueryForm>
        <TransactionID>int</TransactionID>
        <UserID>string</UserID>
        <OnlyNewMessages>boolean</OnlyNewMessages>
        <RecieveTime>
          <Verb>string</Verb>
          <VerbData>string</VerbData>
        </RecieveTime>
      </QueryForm>
      <QueryControl>
        <MaxChunkSize>int</MaxChunkSize>
        <FromRecordNumber>int</FromRecordNumber>
      </QueryControl>
    </GetList2>
  </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>
    <GetList2Response xmlns="http://www.interfax.net">
      <GetList2Result>
        <MessageItems>
          <MessageItem2>
            <UserID>string</UserID>
            <MessageID>int</MessageID>
            <PhoneNumber>string</PhoneNumber>
            <RemoteCSID>string</RemoteCSID>
            <MessageStatus>int</MessageStatus>
            <Pages>int</Pages>
            <MessageSize>int</MessageSize>
            <MessageType>short</MessageType>
            <ReceiveTime>dateTime</ReceiveTime>
            <CallerID>string</CallerID>
            <MessageRecordingDuration>int</MessageRecordingDuration>
            <ImageStatus>string</ImageStatus>
            <NumOfEmails>int</NumOfEmails>
            <NumOfFailedEmails>int</NumOfFailedEmails>
          </MessageItem2>
          <MessageItem2>
            <UserID>string</UserID>
            <MessageID>int</MessageID>
            <PhoneNumber>string</PhoneNumber>
            <RemoteCSID>string</RemoteCSID>
            <MessageStatus>int</MessageStatus>
            <Pages>int</Pages>
            <MessageSize>int</MessageSize>
            <MessageType>short</MessageType>
            <ReceiveTime>dateTime</ReceiveTime>
            <CallerID>string</CallerID>
            <MessageRecordingDuration>int</MessageRecordingDuration>
            <ImageStatus>string</ImageStatus>
            <NumOfEmails>int</NumOfEmails>
            <NumOfFailedEmails>int</NumOfFailedEmails>
          </MessageItem2>
        </MessageItems>
        <ResultCode>int</ResultCode>
        <TotalTransactionsNum>int</TotalTransactionsNum>
      </GetList2Result>
    </GetList2Response>
  </soap12:Body>
</soap12:Envelope>