ReplixFax SOAP Reference

1. Overview
2. Authentication
   1. 1. Describes the two approaches of setting credentials.
      2. Overview
      3. Login
      4. Logout
3. Outbound Faxes
   1. 1. Functions related to outgoing faxes.
      2. Overview
      3. SendFax
      4. ResendFax
      5. QuerySendFax
      6. GetSendFaxContent
      7. DeleteSendFax
      8. ModifySendFax
4. Inbound Faxes
   1. 1. Functions related to incoming faxes.
      2. Overview
      3. QueryReceiveFax
      4. GetReceiveFaxContent
      5. DeleteReceiveFax
      6. ModifyReceiveFax
5. Cover Page Templates
   1. 1. Functions dealing with ReplixFax
         cover page templates.
      2. Overview
      3. EnumerateCoverPages
6. Phonebooks
   1. 1. Functions related to editing
         personal and global phonebooks.
      2. Overview
      3. AddPhoneBookEntry
      4. ModifyPhoneBookEntry
      5. DeletePhoneBookEntry
      6. QueryPhoneBookEntry
      7. AddPhoneBookGroup
      8. ModifyPhoneBookGroup
      9. QueryPhoneBookGroup
      10. AddPhoneBookGroupEntry
      11. DeletePhoneBookGroupEntry
7. Departments
   1. 1. Administrative functions to
         modify ReplixFax departments.
      2. Overview
      3. AddDepartment
      4. ModifyDepartment
      5. DeleteDepartment
      6. QueryDepartment
8. Users
   1. 1. Administrative functions to
         modify ReplixFax users.
      2. Overview
      3. AddUser
      4. ModifyUser
      5. DeleteUser
      6. QueryUser
9. Barcodes
   1. 1. Functions dealing with barcode generation.
      2. Overview
      3. CreateBarcode

1. Developer Home
2. SOAP Reference

Summary

The Softlinx Cloud Fax Web Services API is a set of web services interfaces that use the SOAP protocol to communicate with the Softlinx Cloud Fax Service. The Web Services API allows an application to send faxes, query the status of faxes, retrieve fax images, delete faxes, query/edit users and departments, phonebooks, and perform other fax related tasks.

WSDL

The Softlinx Cloud Fax Web Services definition document (aka WSDL) is located at https://api.rpxtest.com/softlinx/replixfax/wsapi

The URL above is for the Softlinx Cloud Fax test environment. A production URL is provided as part of the customer onboarding process.

XML Schema Element Types

All element types have been limited to "string" or restricted "string" even though some elements semantically are numeric, Boolean or enumerated types. The reason for this is that some WSDL2Code generators produce xxxSpecified "sibling" elements in the proxy class for optional (minOccurs=0) int, Boolean or enumerated string types.

Messages with Attachments

Some APIs send or receive messages that include arbitrary binary attachments. For such messages Softlinx Cloud Fax Service expects (and generates) XML-binary Optimized Packaging (XOP) as specified in W3C recommendation. (See http://www.w3.org/TR/xop10/ for more details.)

Fax Identifiers

Incoming and outgoing faxes are identified by a number called a fax identifier. This number is unique within the outgoing or incoming domain. E.g., outgoing fax 33 describes a different fax from an incoming fax 33. The identifiers are allocated by the fax server in increasing order.

API Input/Output

The WSDL description formally describes the input and output to each API. Each API will have a single input parameter. The input parameter will contain specific information related to the API call. The result of the call will be a single element. This object will contain result information specific to the API call. In addition, each result object will contain a RequestStatus object. This will indicate success or failure of the call.

The Softlinx Cloud Fax Service defaults to Eastern time zone. The client making the web services call may be in a different time zone. Therefore, the time zone is required when specifying a date/time.

Arguments

Most input arguments are optional (unless explicitly stated). Most output arguments are required (unless explicitly stated). For more details about argument and result order refer to the WSDL document.

RequestStatus

Each API result contains a RequestStatus element. This element contains StatusCode and StatusText elements which represent the result status of the request. Check for StatusCode = “0” to verify that request executed correctly.

Keep in mind a status code of “0” for a send fax request does not indicate that the fax was actually sent. It merely indicates that the fax was successfully added to the send queue.

Request Credentials

Each request must be authenticated by providing user id and password credentials or an authentication token. The Softlinx Cloud Fax supports passing the credentials inside the SOAP body of each request or by obtaining a token and supplying the token inside each request. Access to faxes (deleting, retrieving status, and retrieving fax images) is restricted to the “owner” which is determined by the credential passed in the request.

When sending a fax, the owner will be the user specified in the credentials. Optionally, a proxy user can be specified in some API calls. If a proxy user is specified, this user id will be used to limit access to faxes or be the owner of new faxes. A proxy user can only be used if the user in the request credentials has the appropriate privilege.

SOAP request response names

The request element name (child element of SOAP:body element) and response element name (child element of SOAP:body element) follow a convention where if the request element name is "xxx" then the response element name is "xxxResponse". This is formalized in the WSDL specification but in case you are not using tools to generate proxy code from WSDL, this is stated here for clarity.

API version

Each API has a version number stated in the SOAPAction HTTP header, which is required, as declared in binding section of the WSDL document. When the API’s interface changes, the version number is updated but the fax server should generate responses compatible with clients using an older API version.

Authentication Overview

Each Replix SOAP method requires a corresponding input element. Each input element must contain either an Authentication or AuthenticationToken element. The Authentication element contains the username and encoded password. Optionally the Login method can be used to create an authentication token. The Logout method will invalidate the token. The Softlinx Cloud service controls how long a token is valid.

Using the Authentication Element

If the Authentication element is used, then the user credentials are passed with each SOAP call.

Using the AuthenticationToken Element

If the AuthenticationToken element is used, then a Login call must be made first to obtain the token. This call will use the Authentication element to pass user credentials. Subsequent SOAP calls will then contain the token and not an Authentication element.

1. Developer Home
2. Authentication Overview
3. Login

Login

The Login method is a SOAP request for validating user credentials and obtaining an authentication token. If the credentials provided are valid, then the API call returns with an authentication token string that can be used in future requests. Token expiration is controlled by the Softlinx service. If a request is made with an expired token, then the client will receive an exception. The client must issue a new Login request to get a new token.

LoginInput

LoginOutput

1. Developer Home
2. Authentication Overview
3. Logout

Logout

The Logout method is a SOAP request for expiring an existing authentication token.

LogoutInput

LogoutOutput

1. Developer Home
2. Outbound Faxes Overview

Outbound Faxes Overview

The ReplixFax API has methods which allow the sending of a fax request, querying the status of an outbound fax, marking an outbound fax, resubmitting a failed outbound fax and deleting an outbound fax.

1. Developer Home
2. Outbound Faxes Overview
3. SendFax

SendFax

The SendFax method is a SOAP request for submitting a fax to be sent via the server. When the API call returns, the results will contain a Fax identifier that uniquely identifies the outgoing fax. The fax will most likely not have been sent when the call returns. You can query that status of this fax, using the Fax ID return to see when the fax is sent.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=SendFax/ver=17"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:SendFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <SendFaxInput>
                <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <FaxRecipient>
                    <FaxNumber>
fax number
</FaxNumber>
                </FaxRecipient>
                <Attachment>
                    <FileName>
filename
</FileName>
                    <AttachmentContent>
                        [binary data]
                    </AttachmentContent>
                </Attachment>
            </SendFaxInput>
        </ns2:SendFax>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79

<soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
      <soap:Body>
        <rpx:SendFaxResponse>
           <SendFaxOutput>
                <FaxInfo>
                   <FaxId>
fax id
</FaxId>
                   <FaxNumber>
fax number
</FaxNumber>
                </FaxInfo>
                <RequestStatus>
                   <StatusCode>0</StatusCode>
                   <StatusText/>
            </RequestStatus>
            </SendFaxOutput>
        </rpx:SendFaxResponse>
    </soap:Body>
</soap:Envelope>

SendFaxInput

SendFaxOutput

1. Developer Home
2. Outbound Faxes Overview
3. ResendFax

ResendFax

The ResendFax method is a SOAP request for submitting a fax to be resent. This can only be executed against outgoing faxes that have a status of "sendFailed". When the API call returns, the results will contain a Fax identifier that uniquely identifies the outgoing fax. The fax will most likely not have been sent when the call returns. You can query that status of this fax, using the Fax ID return to see when the fax is sent. Note: the original fax will be deleted.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=ResendFax/ver=17"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <S:Body>
          <ns2:ResendFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
           <ResendFaxInput>
               <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <FaxId>
fax id
</FaxId>
                <FaxNumber>
fax numnber
</FaxNumber>
           </ResendFaxInput>
	</ns2:ResendFax>
     </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501C0FA.624ACBB

<soap:Envelope
      xmlns:xop="http://www.w3.org/2004/08/xop/include"
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      xmlns:rpx="http://www.softlinx.com/ReplixFax">
     <soap:Body>
        <rpx:ResendFaxResponse>
           <ResendFaxOutput>
              <FaxInfo>
                    <FaxId>
fax id
</FaxId>
                    <FaxNumber>
fax number
</FaxNumber>
                </FaxInfo>
                <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
               </RequestStatus>
            </ResendFaxOutput>
        </rpx:ResendFaxResponse>
     </soap:Body>
</soap:Envelope>

ResendFaxInput

ResendFaxOutput

1. Developer Home
2. Outbound Faxes Overview
3. QuerySendFax

QuerySendFax

The QuerySendFax method is a SOAP request used to retrieve the metadata information of outgoing faxes, e.g, fax status, date/time the fax was sent, duration, etc.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=QuerySendFax/ver=17"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:QuerySendFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <QuerySendFaxInput>
                 <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                 </Authentication>
                 <FaxId>
fax id
</FaxId>
             </QuerySendFaxInput>
        </ns2:QuerySendFax>
    </S:Body>
</S:Envelope>

TTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501C231.4028C217

<soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
     <soap:Body>
         <rpx:QuerySendFaxResponse>
             <QuerySendFaxOutput>
                <FaxInfo>
					<FaxId>x</FaxId>
					<GroupId>x</GroupId>
					<FaxUserId>x</FaxUserId>
					<FaxNumber>x</FaxNumber>
					<FaxStatus>sent</FaxStatus>
					<CompleteTime>2014-12-05T12:19:36Z</CompleteTime>
					<CreateTime>2014-12-05T12:18:58Z</CreateTime>
					<SendAfter>2014-12-05T12:18:58Z</SendAfter>
					<TSI/>
					<CSI>dobranoc</CSI>
					<Duration>13</Duration>
					<ErrorCode>0</ErrorCode>
					<ErrorText/>
					<PagesTotal>1</PagesTotal>
					<PagesSent>1</PagesSent>
					<FaxQuality>high</FaxQuality>
					<RetryCount>3</RetryCount>
					<RetryCountLeft>2</RetryCountLeft>
					<RetryInterval>15</RetryInterval>
					<CoverPageName/>
					<RcptInfo>:::1(555) 546-7456:</RcptInfo>
					<Priority>5</Priority>
					<FaxDescription/>
					<DeleteAfterSend>true</DeleteAfterSend>
					<NotifyEmailAddress>user@company.com</NotifyEmailAddress>
					<NotifySuccess>true</NotifySuccess>
					<NotifyFailed>true</NotifyFailed>
					<NotifyFailedAttachFax>false</NotifyFailedAttachFax>
					<FaxHeaderEnabled>true</FaxHeaderEnabled>
					<PrintAfterSend>false</PrintAfterSend>
					<ProjectCode/>
					<ProjectCode2/>
					<ImgHost>x</ImgHost>
					<ImgDevice>x</ImgDevice>
					<ImgCountry>1</ImgCountry>
					<Reserved2/>
					<ProxyFaxUserId/>
					<Mark>false</Mark>
					<BatchName/>
					<BatchUniqueId/>
					<FaxHeader>        %d %t    %i  Page  %P of %p</FaxHeader>
				</FaxInfo>
				<RequestStatus>
                   <StatusCode>0</StatusCode>
                   <StatusText/>
               </RequestStatus>
            </QuerySendFaxOutput>
         </rpx:QuerySendFaxResponse>
     </soap:Body>
</soap:Envelope>

QuerySendFaxInput

Response

1. Developer Home
2. Outbound Faxes Overview
3. GetSendFaxContent

GetSendFaxContent

The GetSendFaxContent method is a SOAP request used to retrieve outgoing fax images in either TIFF or PDF format.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=GetSendFaxContent/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
        <ns2:GetSendFaxContent xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <GetSendFaxContentInput>
               <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <FaxId>
fax id
</FaxId>
                <FaxContentType>pdf</FaxContentType>
                <MtomXop>false</MtomXop>
            </GetSendFaxContentInput>
       </ns2:GetSendFaxContent>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501C89A.215C23E6

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
    <soap:Body>
         <rpx:GetSendFaxContentResponse>
            <GetSendFaxContentOutput>
                <FaxContent>
                <ContentType>application/pdf</ContentType>
                <FileName>x.pdf</FileName>
                <ImageContent>[binary data]</ImageContent>
                </FaxContent>
                <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
                 </RequestStatus>
            </GetSendFaxContentOutput>
        </rpx:GetSendFaxContentResponse>
    </soap:Body>
</soap:Envelope>

GetSendFaxContentInput

GetSendFaxContentOutput

1. Developer Home
2. Outbound Faxes Overview
3. DeleteSendFax

DeleteSendFax

The DeleteSendFax method is a SOAP request used to delete outgoing faxes from the fax server.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=DeleteSendFax/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body><ns2:DeleteSendFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
        <DeleteSendFaxInput>
            <Authentication>
                <Login>
username
</Login>
                <Password>
password
d</Password>
                <PasswordSecurity>base64</PasswordSecurity>
                <Realm>
organization
</Realm>
            </Authentication>
            <FaxId>
fax id
</FaxId>
        </DeleteSendFaxInput>
        </ns2:DeleteSendFax>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501D09D.4434DB30

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
     <soap:Body>
        <rpx:DeleteSendFaxResponse>
            <DeleteSendFaxOutput>
            <RequestStatus>
                <StatusCode>0</StatusCode>
                <StatusText/>
            </RequestStatus>
            </DeleteSendFaxOutput>
        </rpx:DeleteSendFaxResponse>
    </soap:Body>
</soap:Envelope>

DeleteSendFaxInput

DeleteSendFaxOutput

1. Developer Home
2. Outbound Faxes Overview
3. ModifySendFax

ModifySendFax

The ModifySend method is a SOAP request used to change metadata pertaining to an outgoing fax.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: qa-10
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=ModifySendFax/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
          <ns2:ModifySendFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
             <ModifySendFaxInput>
                <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                 <FaxId>
fax id
</FaxId>
                <Mark>true</Mark>
            </ModifySendFaxInput>
         </ns2:ModifySendFax>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501D18A.12E8E760

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
<soap:Body>
     <rpx:ModifySendFaxResponse>
        <ModifySendFaxOutput>
           <RequestStatus>
                <StatusCode>0</StatusCode>
                <StatusText/>
            </RequestStatus>
        </ModifySendFaxOutput>
     </rpx:ModifySendFaxResponse>
</soap:Body>
</soap:Envelope>

ModifySendFaxInput

ModifySendFaxOutput

1. Developer Home
2. Inbound Faxes Overview

Inbound Faxes Overview

The ReplixFax API has methods which querying the status of a received fax, marking an inbound fax, and deleting an inbound fax.

1. Developer Home
2. Inbound Faxes Overview
3. QueryReceiveFax

QueryReceiveFax

The QueryReceiveFax method is a SOAP request used to retrieve incoming fax metadata information, e.g, fax status, date/time the fax was sent, duration, etc. If using this method to check for newly arrived faxes, it is recommended that the interval between requests be at least 10 minutes and that administrative api credentials be used so that all faxes can be retrieved for multiple user vs. making separate queries for each individual user. Following these guidelines will optimize performance.

Another approach of checking for newly arrived faxes is to utilize the URL callback feature. This mechanism results in immediate notification of newly arrived faxes.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=QueryReceiveFax/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
         <ns2:QueryReceiveFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <QueryReceiveFaxInput>
                <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <FaxId>
fax id
</FaxId>
            </QueryReceiveFaxInput>
        </ns2:QueryReceiveFax>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C849.37C24AB1

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
     <soap:Body>
         <rpx:QueryReceiveFaxResponse>
             <QueryReceiveFaxOutput>
                  <FaxInfo>
                    <FaxId>x</FaxId>
                    <FaxUserId>x</FaxUserId>
                    <FaxStatus>recvOk</FaxStatus>
                    <TSI>x.</TSI>
                    <CSI/>
                    <ReceivedTime>2015-02-20T18:42:58Z</ReceivedTime>
					<CreateTime>2015-02-20T18:42:58Z</CreateTime>
					<PagesReceived>1</PagesReceived>
					<DestFaxNumber>x</DestFaxNumber>
					<CallerNumber/>
                    <Duration>0</Duration>
                    <ErrorCode>0</ErrorCode>
                    <ErrorText/>
                    <NotifyEmail>true</NotifyEmail>
                    <NotifyAttachFax>true</NotifyAttachFax>
                    <PrintFax>false</PrintFax>
                    <Viewed>true</Viewed>
                    <ImgHost>x</ImgHost>
                    <ImgDevice>network</ImgDevice>
                    <Caption/>
                    <Note/>
                    <ImgCountry/>
                    <Mark>true</Mark>
                    <ProjectCode>xxx</ProjectCode>
                    <ProjectCode2/>
                </FaxInfo>
                <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
                </RequestStatus>
            </QueryReceiveFaxOutput>
        </rpx:QueryReceiveFaxResponse>
    </soap:Body>
</soap:Envelope>

QueryReceiveFaxInput

QueryReceiveFaxOutput

1. Developer Home
2. Inbound Faxes Overview
3. GetReceiveFaxContent

GetReceiveFaxContent

The GetReceiveFaxContent method is a SOAP request used to retrieve incoming fax images in either TIFF or PDF format.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=GetReceiveFaxContent/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body><ns2:GetReceiveFaxContent xmlns:ns2="http://www.softlinx.com/ReplixFax">
          <GetReceiveFaxContentInput>
               <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
             <FaxId>
fax id
</FaxId>
             <FaxContentType>pdf</FaxContentType>
             >MtomXop>false</MtomXop>
             </GetReceiveFaxContentInput>
        </ns2:GetReceiveFaxContent>
     </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C90E.958FF19

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
     <soap:Body>
         <rpx:GetReceiveFaxContentResponse>
            <GetReceiveFaxContentOutput>
               <FaxContent>
                    <ContentType>application/pdf</ContentType>
                    <FileName>x.pdf</FileName>
                    <ImageContent>[binary data]</ImageContent>
                </FaxContent>
                <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
                </RequestStatus>
          </GetReceiveFaxContentOutput>
        </rpx:GetReceiveFaxContentResponse>
    </soap:Body>
</soap:Envelope>

GetReceiveFaxContentInput

GetReceiveFaxContentOutput

1. Developer Home
2. Inbound Faxes Overview
3. DeleteReceiveFax

DeleteReceiveFax

The DeleteReceiveFax method is a SOAP request used to delete received faxes from the fax server.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=DeleteReceiveFax/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
         <ns2:DeleteReceiveFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
           <DeleteReceiveFaxInput>
             <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <FaxId>
fax id
</FaxId>
           </DeleteReceiveFaxInput>
        </ns2:DeleteReceiveFax>
     </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C9C6.3CC8C9E9

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
    <soap:Body>
         <rpx:DeleteReceiveFaxResponse>
           <DeleteReceiveFaxOutput>
              <RequestStatus>
                   <StatusCode>0</StatusCode>
                   <StatusText/>
             </RequestStatus>
             </DeleteReceiveFaxOutput>
         </rpx:DeleteReceiveFaxResponse>
    </soap:Body>
</soap:Envelope>

DeleteReceiveFaxInput

DeleteReceiveFaxOutput

1. Developer Home
2. Inbound Faxes Overview
3. ModifyReceiveFax

ModifyReceiveFax

The ModifyReceiveFax method is a SOAP request used to change metadata pertaining to a received fax.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=ModifyReceiveFax/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
         <ns2:ModifyReceiveFax xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <ModifyReceiveFaxInput>
               <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <FaxId>
fax id
</FaxId>
                <Mark>true</Mark>
            </ModifyReceiveFaxInput>
         </ns2:ModifyReceiveFax>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C970.3070AD64

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
   <soap:Body>
       <rpx:ModifyReceiveFaxResponse>
            <ModifyReceiveFaxOutput>
              <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
              </RequestStatus>
            </ModifyReceiveFaxOutput>
         </rpx:ModifyReceiveFaxResponse>
     </soap:Body>
</soap:Envelope>

ModifyReceiveFaxInput

ModifyReceiveFaxOutput

1. Developer Home
2. Cover Page Templates

Cover Page Overview

Softlinx provides cover page templates that can be specified when submitting a fax request. If recipient information is supplied during the request such as company, phone number,... then this data can optionally appear on the cover page. Customers can request Sofltinx create a custom cover page.

Cover Page Templates

To programmatically use a Softlinx cover page template when sending a fax, you must set SendFaxInput.CoverPageEnabled="true" and then set the SendFaxInput.CoverPageName attribute to the name of the cover page template. There are 4 standard cover page templates: cover, facsimile, memo, and urgent. Custom cover pages can be created by Softlinx. To request a custom cover page template, contact Softlinx support.

Cover Page Metadata Fields

The following table describes the user, fax and recipient attributes that can be dynamically populated into a cover page template.

Description	How to Set Value
Sender's name	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Recipient's name	FaxRecipient.RcptName
Recipient's company name	FaxRecipient.RcptCompany
Recipient's title	FaxRecipient.RcptTitle
Recipient's fax number	FaxRecipient.RcptFax
Recipient's voice number	FaxRecipient.RcptVoice
Carbon Copy	SendFaxInput.CoverFieldCC
Cover page message	SendFaxInput.CoverMessage
Total Pages
Date of fax transmission
Sender's voice number	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's DID number	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's department name	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's company name	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's address lines	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's job title	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's email address	Taken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Project Codes	Five values specified when sending a fax. Two can have default values associated with the user or the user’s department.

Standard Cover Pages

cover

memo

urgent

facsimile

1. Developer Home
2. Cover Page Templates
3. EnumerateCoverPages

EnumerateCoverPages

The EnumerateCoverPages method is a SOAP request used to get a list of cover page names that are available on the fax server for a specific user.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=EnumerateCoverPages/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
         <ns2:EnumerateCoverPages xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <EnumerateCoverPagesInput>
                 <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                 </Authentication>
            </EnumerateCoverPagesInput>
        </ns2:EnumerateCoverPages>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502D235.14526F48

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
     <soap:Body>
          <rpx:EnumerateCoverPagesResponse>
             <EnumerateCoverPagesOutput>
                <CoverPage>cover</CoverPage>
                <CoverPage>facsimile</CoverPage>
                <CoverPage>memo</CoverPage>
                <CoverPage>urgent</CoverPage>
                <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
               </RequestStatus>
           </EnumerateCoverPagesOutput>
       </rpx:EnumerateCoverPagesResponse>
   </soap:Body>
</soap:Envelope>

EnumerateCoverPagesInput

EnumerateCoverPagesOutput

1. Developer Home
2. Phonebooks

Phonebooks (Contacts) Overview

A Softlinx Cloud phonebook is a collection of phonebook entries and/or phonebook groups. A phonebook entry contains a relevant information such as email address, fax number, and name. A phonebook group is a collection of phonebook entries.

Softlinx Cloud supports two types of phonebooks: global and personal. The global phonebook is viewable to all users. Only a user with Admin API permission can modify the global phonebook. A personal phonebook is associated with each Softlinx Cloud user. Only that user can access their phonebook.

1. Developer Home
2. Phonebooks
3. AddPhoneBookEntry

AddPhoneBookEntry

The AddPhoneBookEntry method is a SOAP request for creating a phonebook entry in either the personal or global phonebooks. When the API call returns, the results will indicate whether the new entry was successfully created. Only users with the "Allow Admin API" privilege can create entries in the global phonebook.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=AddPhoneBookEntry/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
       <ns2:AddPhoneBookEntry xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <AddPhoneBookEntryInput>
                <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <PhoneBookEntryInfo>
                    <Name>John Doe</Name>
                    <FaxNumber>15559990303</FaxNumber>
                    <Company>Acme</Company>
                    <PhoneNumber>15556667722</PhoneNumber>
               </PhoneBookEntryInfo>
            </AddPhoneBookEntryInput>
        </ns2:AddPhoneBookEntry>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502D43A.48C49D71

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
    <soap:Body>
         <rpx:AddPhoneBookEntryResponse>
            <AddPhoneBookEntryOutput>
            <Id>x</Id>
            <RequestStatus>
                <StatusCode>0</StatusCode>
                <StatusText/>
            </RequestStatus>
             </AddPhoneBookEntryOutput>
        </rpx:AddPhoneBookEntryResponse>
     </soap:Body>
</soap:Envelope>

AddPhoneBookEntryInput

AddPhoneBookEntryOutput

1. Developer Home
2. Phonebooks
3. ModifyPhoneBookEntry

ModifyPhoneBookEntry

The ModifyPhoneBookEntry method is a SOAP request for updating a phonebook entry for an existing phonebook. When the API call returns, the results will indicate whether the entry was successfully updated. Only users with the "Allow Admin API" privilege can update entries in the global phonebook.

ModifyPhoneBookEntryInput

ModifyPhoneBookEntryOutput

1. Developer Home
2. Phonebooks
3. DeletePhoneBookEntry

DeletePhoneBookEntry

The DeletePhoneBookEntry method is a SOAP request for deleting a phonebook entry for an existing phonebook. When the API call returns, the results will indicate whether the entry was successfully deleted. Only users with the "Allow Admin API" privilege can delete entries in the global phonebook.

DeletePhoneBookEntryInput

DeletePhoneBookEntryOutput

1. Developer Home
2. Phonebooks
3. QueryPhoneBookEntry

QueryPhoneBookEntry

The wQueryPhoneBookEntry method is a SOAP request for searching for a phonebook entry for an existing phonebook. When the API call returns, the results will indicate whether the entry was successfully found. Use this method to find all entries that are members of a phonebook group.

QueryPhoneBookEntryInput

QueryPhoneBookEntryOutput

1. Developer Home
2. Phonebooks
3. AddPhoneBookgroup

AddPhonebookGroup

The AddPhoneBookEntry method is a SOAP request for creating a phonebook entry in an existing phonebook. When the API call returns, the results will indicate whether the new entry was successfully created. Only users with the "Allow Admin API" privilege can create entries in the global phonebook.

AddPhonebookGroupInput

AddPhonebookGroupOutput

1. Developer Home
2. Phonebooks
3. ModifyPhoneBookGroup

ModifyPhoneBookGroup

The ModifyPhoneBookGroup method is a SOAP request for updating a phonebook group. When the API call returns, the results will indicate whether the entry was successfully updated. Only users with the "Allow Admin API" privilege can update phonebook groups in the global phonebook.

ModifyPhoneBookGroupInput

ModifyPhoneBookGroupOutput

1. Developer Home
2. Phonebooks
3. QueryPhoneBookGroup

QueryPhoneBookGroup

The QueryPhoneBookGroup method is a SOAP request for searching for a phonebook group from an existing phonebook. When the API call returns, the results will indicate whether the group was successfully found.

QueryPhoneBookGroupInput

QueryPhoneBookGroupOutput

1. Developer Home
2. Phonebooks
3. AddPhoneBookGroupEntry

AddPhonebookGroupEntry

The AddPhoneBookGroupEntry method is a SOAP request for adding a phonebook entry in an existing phonebook group. When the API call returns, the results will indicate whether the new entry was successfully added. Only users with the "Allow Admin API" privilege can add members to a group in the global phonebook.

AddPhonebookGroupEntryInput

AddPhonebookGroupEntryOutput

1. Developer Home
2. Phonebooks
3. DeletePhoneBookGroupEntry

DeletePhonebookGroupEntry

The DeletePhoneBookGroupEntry method is a SOAP request for removing a member from a phonebook group. When the API call returns, the results will indicate whether the entry was successfully updated. Only users with the "Allow Admin API"? privilege can remove members from a group in the global phonebook.

DeletePhonebookGroupEntryInput

DeletePhonebookGroupEntryOutput

1. Developer Home
2. Departments

Departments Overview

A department contains default values for user attributes. When a user performs an action like sending a fax or submitting a secure document certain attributes can be obtained from the department. A user can only be a member of a single group.

1. Developer Home
2. Departments
3. AddDepartment

AddDepartment

The AddDepartment method is a SOAP request for creating a new Softlinx Cloud department. When the API call returns, the results will indicate whether the new department was successfully created. Only users with the "Allow Admin API" privilege can create new departments.

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
Accept: text/xml, multipart/related
Authorization: BASIC XXX
Host: 
server
User-Agent: JAX-WS RI 2.2.4-b01
SOAPAction: "http://www.softlinx.com/wsapi/op=AddDepartment/ver=19"

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
          <ns2:AddDepartment xmlns:ns2="http://www.softlinx.com/ReplixFax">
            <AddDepartmentInput>
              <Authentication>
                    <Login>
username
</Login>
                    <Password>
password
d</Password>
                    <PasswordSecurity>base64</PasswordSecurity>
                    <Realm>
organization
</Realm>
                </Authentication>
                <DepartmentInfo>
                    <Name>Sales</Name>
                    <ProjectCode>sales-123</ProjectCode>
               </DepartmentInfo>
            </AddDepartmentInput>
        </ns2:AddDepartment>
    </S:Body>
</S:Envelope>

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8
X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502D530.4BE2F31A

<soap:Envelope
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:rpx="http://www.softlinx.com/ReplixFax">
    <soap:Body>
       <rpx:AddDepartmentResponse>
           <AddDepartmentOutput>
                 <RequestStatus>
                    <StatusCode>0</StatusCode>
                    <StatusText/>
               </RequestStatus>
           </AddDepartmentOutput>
       </rpx:AddDepartmentResponse>
    </soap:Body>
</soap:Envelope>

AddDepartmentInput

AddDepartmentOutput

1. Developer Home
2. Departments
3. ModifyDepartment

ModifyDepartment

The ModifyDepartment method is a SOAP request for updating a new Softlinx Cloud department. When the API call returns, the results will indicate whether the new department was successfully updated. Only users with the "Allow Admin API" privilege can modify departments.

ModifyDepartmentInput

ModifyDepartmentOutput

1. Developer Home
2. Departments
3. DeleteDepartment

DeleteDepartment

The DeleteDepartment method is a SOAP request for deleting a Softlinx Cloud department. When the API call returns, the results will indicate whether the new department was successfully deleted. Only users with the "Allow Admin API" privilege can delete departments.

DeleteDepartmentInput

DeleteDepartmentOutput

1. Developer Home
2. Departments
3. QueryDepartment

QueryDepartment

The QueryDepartment method is a SOAP request for searching for Softlinx Cloud departments. When the API call returns, the results will indicate whether any departments were found that matched the search criteria. Only users with the "Allow Admin API" privilege can query departments.

QueryDepartmentInput

QueryDepartmentOutput