Outbound Web Service

Outbound

Click here for a complete list of operations.

Submit

Send fax with a cover page, inbound fax messages and uploaded files

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 /Outbound.asmx HTTP/1.1
Host: ws-sl.fax.tc
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "interfax.net/Submit"

<?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>
    <Submit xmlns="interfax.net">
      <token>string</token>
      <FaxNumber>string</FaxNumber>
      <Contact>string</Contact>
      <Reference>string</Reference>
      <properties>
        <RetriesToPerform>int</RetriesToPerform>
        <CSID>string</CSID>
        <PageHeader>string</PageHeader>
        <PageSize>string</PageSize>
        <PageOrientation>string</PageOrientation>
        <IsHighResolution>boolean</IsHighResolution>
        <IsFineRendering>boolean</IsFineRendering>
      </properties>
      <CPdata>
        <Name>string</Name>
        <Dictionary>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Dictionary>
        <AddCompanyName>boolean</AddCompanyName>
      </CPdata>
      <InboundTransactions>
        <InboundDocument>
          <TransactionID>long</TransactionID>
          <PageList>string</PageList>
        </InboundDocument>
        <InboundDocument>
          <TransactionID>long</TransactionID>
          <PageList>string</PageList>
        </InboundDocument>
      </InboundTransactions>
      <UploadedDocuments>
        <string>string</string>
        <string>string</string>
      </UploadedDocuments>
      <Language>string</Language>
    </Submit>
  </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>
    <SubmitResponse xmlns="interfax.net">
      <SubmitResult>
        <Code>int</Code>
        <Description>string</Description>
        <Data>long</Data>
      </SubmitResult>
    </SubmitResponse>
  </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 /Outbound.asmx HTTP/1.1
Host: ws-sl.fax.tc
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>
    <Submit xmlns="interfax.net">
      <token>string</token>
      <FaxNumber>string</FaxNumber>
      <Contact>string</Contact>
      <Reference>string</Reference>
      <properties>
        <RetriesToPerform>int</RetriesToPerform>
        <CSID>string</CSID>
        <PageHeader>string</PageHeader>
        <PageSize>string</PageSize>
        <PageOrientation>string</PageOrientation>
        <IsHighResolution>boolean</IsHighResolution>
        <IsFineRendering>boolean</IsFineRendering>
      </properties>
      <CPdata>
        <Name>string</Name>
        <Dictionary>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Dictionary>
        <AddCompanyName>boolean</AddCompanyName>
      </CPdata>
      <InboundTransactions>
        <InboundDocument>
          <TransactionID>long</TransactionID>
          <PageList>string</PageList>
        </InboundDocument>
        <InboundDocument>
          <TransactionID>long</TransactionID>
          <PageList>string</PageList>
        </InboundDocument>
      </InboundTransactions>
      <UploadedDocuments>
        <string>string</string>
        <string>string</string>
      </UploadedDocuments>
      <Language>string</Language>
    </Submit>
  </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>
    <SubmitResponse xmlns="interfax.net">
      <SubmitResult>
        <Code>int</Code>
        <Description>string</Description>
        <Data>long</Data>
      </SubmitResult>
    </SubmitResponse>
  </soap12:Body>
</soap12:Envelope>