InterFax Web Service

InterFax

Click here for a complete list of operations.

FaxQuery

Returns full information (27 fields - see Reference) regarding a population determined by Verb.

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

<?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>
    <FaxQuery xmlns="http://www.interfax.cc">
      <Username>string</Username>
      <Password>string</Password>
      <Verb>string</Verb>
      <VerbData>string</VerbData>
      <MaxItems>int</MaxItems>
      <ResultCode>int</ResultCode>
    </FaxQuery>
  </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>
    <FaxQueryResponse xmlns="http://www.interfax.cc">
      <FaxQueryResult>
        <FaxItemEx>
          <ParentTransactionID>int</ParentTransactionID>
          <TransactionID>int</TransactionID>
          <SubmitTime>dateTime</SubmitTime>
          <PostponeTime>dateTime</PostponeTime>
          <CompletionTime>dateTime</CompletionTime>
          <UserID>string</UserID>
          <Contact>string</Contact>
          <JobID>string</JobID>
          <DestinationFax>string</DestinationFax>
          <ReplyEmail>string</ReplyEmail>
          <RemoteCSID>string</RemoteCSID>
          <PagesSent>short</PagesSent>
          <Status>int</Status>
          <Duration>int</Duration>
          <Subject>string</Subject>
          <PagesSubmitted>short</PagesSubmitted>
          <SenderCSID>string</SenderCSID>
          <Priority>short</Priority>
          <Units>decimal</Units>
          <CostPerUnit>decimal</CostPerUnit>
          <PageSize>string</PageSize>
          <PageOrientation>string</PageOrientation>
          <PageResolution>string</PageResolution>
          <RenderingQuality>string</RenderingQuality>
          <PageHeader>string</PageHeader>
          <RetriesToPerform>short</RetriesToPerform>
          <TrialsPerformed>short</TrialsPerformed>
        </FaxItemEx>
        <FaxItemEx>
          <ParentTransactionID>int</ParentTransactionID>
          <TransactionID>int</TransactionID>
          <SubmitTime>dateTime</SubmitTime>
          <PostponeTime>dateTime</PostponeTime>
          <CompletionTime>dateTime</CompletionTime>
          <UserID>string</UserID>
          <Contact>string</Contact>
          <JobID>string</JobID>
          <DestinationFax>string</DestinationFax>
          <ReplyEmail>string</ReplyEmail>
          <RemoteCSID>string</RemoteCSID>
          <PagesSent>short</PagesSent>
          <Status>int</Status>
          <Duration>int</Duration>
          <Subject>string</Subject>
          <PagesSubmitted>short</PagesSubmitted>
          <SenderCSID>string</SenderCSID>
          <Priority>short</Priority>
          <Units>decimal</Units>
          <CostPerUnit>decimal</CostPerUnit>
          <PageSize>string</PageSize>
          <PageOrientation>string</PageOrientation>
          <PageResolution>string</PageResolution>
          <RenderingQuality>string</RenderingQuality>
          <PageHeader>string</PageHeader>
          <RetriesToPerform>short</RetriesToPerform>
          <TrialsPerformed>short</TrialsPerformed>
        </FaxItemEx>
      </FaxQueryResult>
      <ResultCode>int</ResultCode>
    </FaxQueryResponse>
  </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 /dfs.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>
    <FaxQuery xmlns="http://www.interfax.cc">
      <Username>string</Username>
      <Password>string</Password>
      <Verb>string</Verb>
      <VerbData>string</VerbData>
      <MaxItems>int</MaxItems>
      <ResultCode>int</ResultCode>
    </FaxQuery>
  </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>
    <FaxQueryResponse xmlns="http://www.interfax.cc">
      <FaxQueryResult>
        <FaxItemEx>
          <ParentTransactionID>int</ParentTransactionID>
          <TransactionID>int</TransactionID>
          <SubmitTime>dateTime</SubmitTime>
          <PostponeTime>dateTime</PostponeTime>
          <CompletionTime>dateTime</CompletionTime>
          <UserID>string</UserID>
          <Contact>string</Contact>
          <JobID>string</JobID>
          <DestinationFax>string</DestinationFax>
          <ReplyEmail>string</ReplyEmail>
          <RemoteCSID>string</RemoteCSID>
          <PagesSent>short</PagesSent>
          <Status>int</Status>
          <Duration>int</Duration>
          <Subject>string</Subject>
          <PagesSubmitted>short</PagesSubmitted>
          <SenderCSID>string</SenderCSID>
          <Priority>short</Priority>
          <Units>decimal</Units>
          <CostPerUnit>decimal</CostPerUnit>
          <PageSize>string</PageSize>
          <PageOrientation>string</PageOrientation>
          <PageResolution>string</PageResolution>
          <RenderingQuality>string</RenderingQuality>
          <PageHeader>string</PageHeader>
          <RetriesToPerform>short</RetriesToPerform>
          <TrialsPerformed>short</TrialsPerformed>
        </FaxItemEx>
        <FaxItemEx>
          <ParentTransactionID>int</ParentTransactionID>
          <TransactionID>int</TransactionID>
          <SubmitTime>dateTime</SubmitTime>
          <PostponeTime>dateTime</PostponeTime>
          <CompletionTime>dateTime</CompletionTime>
          <UserID>string</UserID>
          <Contact>string</Contact>
          <JobID>string</JobID>
          <DestinationFax>string</DestinationFax>
          <ReplyEmail>string</ReplyEmail>
          <RemoteCSID>string</RemoteCSID>
          <PagesSent>short</PagesSent>
          <Status>int</Status>
          <Duration>int</Duration>
          <Subject>string</Subject>
          <PagesSubmitted>short</PagesSubmitted>
          <SenderCSID>string</SenderCSID>
          <Priority>short</Priority>
          <Units>decimal</Units>
          <CostPerUnit>decimal</CostPerUnit>
          <PageSize>string</PageSize>
          <PageOrientation>string</PageOrientation>
          <PageResolution>string</PageResolution>
          <RenderingQuality>string</RenderingQuality>
          <PageHeader>string</PageHeader>
          <RetriesToPerform>short</RetriesToPerform>
          <TrialsPerformed>short</TrialsPerformed>
        </FaxItemEx>
      </FaxQueryResult>
      <ResultCode>int</ResultCode>
    </FaxQueryResponse>
  </soap12:Body>
</soap12:Envelope>