Summary

The Softlinx Cloud Web Services API is a set of web services interfaces that use the SOAP protocol to communicate with the Softlinx Cloud Service. The Web Services API for ReplixDoc allows an application to send secure document messages, query secure document messages, manage recipients, and retrieve secure documents. Additional methods are available to manage ReplixDoc users, departments and contact lists (phonebooks).


WSDL

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

The URL above is for the Softlinx Cloud 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 Service expects (and generates) XML-binary Optimized Packaging (XOP) as specified in W3C recommendation. (See http://www.w3.org/TR/xop10/ for more details.)

Message Identifiers

Outgoing secure document messages are identified by a unique string called a message identifier. When a SmSendMessage() request is made, a different unique message id is assigned to each recipient of this message. For example, if a secure document message is sent to a single recipient, then only one message identifier is created. If a secure document message is sent to three recipients, then three message identifiers are created.

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 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.

Request Credentials

Each request must be authenticated by providing user id (or recipient email) and password credentials or an authentication token. The Softlinx Cloud supports passing the credentials inside the SOAP body of each request or by obtaining a token and supplying the token inside each request.

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 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.


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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.

LoginOutput

NameTypeDescription
AuthTokenstringString that contains token if credentials were validated.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

Logout

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

LogoutInput

NameTypeDescription
AuthTokenstringString that contains the token if credentials were validated.

LogoutOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

Outbound Secure Document Message Overview

The ReplixDoc API has methods which allow the sending of secure document messages, querying the status of these messages, canceling a message and resending a message.


SmSendMessage

The SmSendMessage method initiates a secure document message to one or more recipients. The secure document message consists of a subject, an optional note text, and one or more documents. An email message will be sent to each recipient. The documents are not included in the email and are only available after the recipient has provided appropriate credentials. The note can be included in the email body or be protected and viewable only with the documents.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmSendMessage/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmSendMessage xmlns="http://www.softlinx.com/ReplixFax"> <SmSendMessageInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <Recipient> <Email>sandy@acme.com</Email> <Name>Sandy Smith</Name> </Recipient> <Attachment> <FileName>Showcase.xlsx</FileName> <AttachmentContent> <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:http://tempuri.org/1/635926076122942566" /> </AttachmentContent> </Attachment> <Subject>This is a secure email from Joe.</Subject> <MessageText>This is my message.</MessageText> <NotifyEmailAddress>jdoe@company.com</NotifyEmailAddress> <NotifyWhenOpened>true</NotifyWhenOpened> <ProjectCode>project 123</ProjectCode> </SmSendMessageInput> </SmSendMessage> </s:Body> </s:Envelope> --uuid:ecfebe2f-92f1-4160-bbe0-7ee1dd985f81+id=1 Content-ID: <http://tempuri.org/1/635926076122942566> Content-Transfer-Encoding: binary Content-Type: application/octet-stream [binary data]

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmSendMessageResponse> <SmSendMessageOutput> <NewMessage> <MessageId>ec91f7f4cbdab005976e067654efb0c6</MessageId> <Email>jsoe@company.com</Email> </NewMessage> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmSendMessageOutput> </rpx:SmSendMessageResponse> </soap:Body> </soap:Envelope>

SmSendMessageInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
RecipientList of Email addresses of recipients for the secure document message.

SmMessageRecipient

NameTypeDescription
EmailstringEmail address that uniquely identifies each recipient
NamestringRecipient name.
AttachmentList of Documents related to the message. These documents will NOT be sent in the email message.

Attachment

NameTypeDescription
ContentTypestringMIME type of the attachment. This is optional. If "ContentType" is missing, the file name extension is used to determine the type of document and in turn which converter to use to create the fax image from this attachment. E.g. "application/pdf".
FileNamestringFilename of the attachment. This is required. E.g, mydocument.pdf. If "ContentType" is missing, the file name extension is interpreted as the content type to determine the converter to select to create the fax image from this attachment.
AttachmentContent base64BinaryContent of the attachment.
SubjectstringSubject of email message.
NotestringOptional message to be included in the email body or visible when viewing the secure document message.
MessageTemplateIdstringID of an existing notification email template to use in the body of the email notification. If not specified, then the default message template will be used.
NotifyEmailAddressstringEmail address to use if notification is sent when the message is opened. If not set, then the notification will be sent to the sender's email.
NotifyWhenOpenedIf set to "true", then an email is sent when the message is opened by the recipient client. Do not set this to use the sender's default settings.

Boolean

ValuesDescription
trueTrue
falseFalse.
ProjectCodestringOptional string that can be set and used later for billing purposes.
UserIdstringIf the authentication credentials are of a Replix user that has proxy permissions, then the UserId can be set to send the message on behalf of a different Replix user.
RequestOriginstringIf set, can identify which client made the request.
ExpireAfterDaysstringNumber of days after message creation before message will be removed from the system.
RemindAfterDaysstringIf not 0 and message has not been accessed, the number of days after message creation to send a reminder email to the recipient.

SmSendMessageOutput

NameTypeDescription
NewMessageList of Information about the secure messages.

SmNewMessageInfo

NameTypeDescription
MessageIdstringUnique identifier of a message.
EmailstringEmail address of the recipient.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmQuerySendMessage

The SmQuerySendMessage method retrieves summary information pertaining to existing messages. Queries can be made based on status, date range, marked, or for a specific sender. Only users with administrative privilege can retrieve messages from a different sender. Note and file details are not available via this API.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:93dc064f-369e-4acf-80d0-80f5a7390c82+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host: qa-10 MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo0fb6M5Ph5hErJv9gBLjxbsAAAAA06nxNzCocki/jwrNZlnaCCJ9S83zMitGkgH6lAm7igEACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmQuerySendMessage/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmQuerySendMessage xmlns="http://www.softlinx.com/ReplixFax"> <SmQuerySendMessageInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <RecipientEmail /> <SortOrder>asc</SortOrder> <ResultLimit>10</ResultLimit> </SmQuerySendMessageInput> </SmQuerySendMessage> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmQuerySendMessageResponse> <SmQuerySendMessageOutput> <Message> <MessageId>8f7d6eecf669ae2128ac8ca979719d04</MessageId> <CreateTime>2016-01-26T16:49:21Z</CreateTime> <RecipientEmail>user@company.com</RecipientEmail> <MessageStatus>accessed</MessageStatus> <UserId>joe</UserId> <Subject>important documets to be reviewed asap</Subject> <ProjectCode /> <AccessTime>2016-02-18T11:53:30Z</AccessTime> <Mark>false</Mark> <Canceled>false</Canceled> </Message> <Message> <MessageId>c3b17e607729fe234e6ceb7a9491ddef</MessageId> <CreateTime>2016-01-26T16:49:21Z</CreateTime> <RecipientEmail>smith@acme.com</RecipientEmail> <MessageStatus>submitted</MessageStatus> <UserId>joe</UserId> <Subject>important documets to be reviewed asap</Subject> <ProjectCode /> <Mark>false</Mark> <Canceled>true</Canceled> </Message> <HasMoreResults>true</HasMoreResults> <ResultsReference>TGFzdFJlY0lkPTIwMTYtMDItMDRUMTElM0ExMCUzQTM3JTJDMTk5ODA7UmVzdWx0TGltaXQ9MTA7U29ydE9yZGVyPWFzYztfdGltZT0yMDE2LTAzLTAzVDE5JTNBNDAlM0EzM1o=</ResultsReference> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmQuerySendMessageOutput> </rpx:SmQuerySendMessageResponse> </soap:Body> </soap:Envelope>

SmQuerySendMessageInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringLimit the search results to a single message.
MessageStatusLimit the search results to messages with a specific status.

SmMessageStatus

ValuesDescription
readyMessage is in system.
RecipientEmailstringLimit the search results to messages to a specific recipient.
UserIdstringLimit the search results from a specific Replix user.
DatetimeAfterstringLimit the search results to messages sent after this datetime.
DatetimeBeforestringLimit the search results to messages sent before this datetime.
MarkLimit the search results based on the mark value of "true" or "false".

Boolean

ValuesDescription
trueTrue
falseFalse.
Canceled Limit the search results based on the cancelled value of "true" or "false".

Boolean

ValuesDescription
trueTrue
falseFalse.
Accessed Limit the search results based on the Accessed value of "true" or "false".

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyStatus Limit the search results based on the email notification status.

NotifyStatus

ValuesDescription
spooledMessage awaits in Replix Server outbound queue.
relayedReplix Server forwarded message to configured mailhost.
sentDSN received, mailhost reported the message has been forwarded to next mail server, assuming mailhost does MX resolution, this usually means that mail was relayed to the recipient MX server.
failedDSN received, mailhost reported failure to send the message.
delayedDSN received, mailhost reported the message has been delayed.
sendingMessage in the process of being sent.
SortOrderOrder of the search results.

QuerySortOrder

ValuesDescription
ascSort ascending.
descSort descending.
ResultLimitLimit the number of messages returned in the search.

PositiveInt

TypeDescription
stringAn integer greater than 0.
GetNextResultsstringIf a query was issued with the ResultLimit set and the results HasMoreResults is "true", then there are more results that match the criteria. To get to the next set of messages, reissue the query, but set GetNextResults to the value returned in the ResultsReference attribute. If GetNextResults is set, then any changes to the original search criteria on subsequent queries is ignored, except for ResultLimit. In other words, if GetNextResults is set, you cannot alter the query when getting the next set of messages, except for the number of messages to return

SmQuerySendMessageOutput

NameTypeDescription
MessageList of Information about the messages.

SmSendMessageDetail

NameTypeDescription
MessageIdstringUnique identifier of a message.
CreateTimestringDate and time message was created.
RecipientEmailstringEmail of recipient.
MessageStatusStatus of message.

SmMessageStatus

ValuesDescription
readyMessage is in system.
UserIdstringReplix user that sent the message.
SubjectstringOptional subject.
AttachmentCount Number of files attached to message.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
ProjectCodestringOptional metadata to be used to group messages.
AccessTimestringDate and time message was opened by recipient using the recipient client.
MarkBooleanFlag to indicate that message was ready. This may be set by an application.
CanceledBooleanDate and time sender canceled the message.
NotifyStatusStatus of email notification.

NotifyStatus

ValuesDescription
spooledMessage awaits in Replix Server outbound queue.
relayedReplix Server forwarded message to configured mailhost.
sentDSN received, mailhost reported the message has been forwarded to next mail server, assuming mailhost does MX resolution, this usually means that mail was relayed to the recipient MX server.
failedDSN received, mailhost reported failure to send the message.
delayedDSN received, mailhost reported the message has been delayed.
sendingMessage in the process of being sent.
NotifyStatusExStringDiagnostic/technical abstract of received DSN, should contain the reason for failure.
NotifyStatusTimeStringDate and time the notify status was updated.
ExpireTimeStringDate and time the message will be allowed to be purged from the system. The actual removal may occur a day after this date.
RemindAfterTimeStringDate to remind the recipient if they have not accessed the email.
RemindStatusStatus of reminder email notification.

NotifyStatus

ValuesDescription
spooledMessage awaits in Replix Server outbound queue.
relayedReplix Server forwarded message to configured mailhost.
sentDSN received, mailhost reported the message has been forwarded to next mail server, assuming mailhost does MX resolution, this usually means that mail was relayed to the recipient MX server.
failedDSN received, mailhost reported failure to send the message.
delayedDSN received, mailhost reported the message has been delayed.
sendingMessage in the process of being sent.
RemindStatusExStringDiagnostic/technical abstract of received DSN, should contain the reason for failure.
RemindStatusTimeStringDate and time the remind status was updated.
AccessNotifyStatusStatus of accessed email notification.

NotifyStatus

ValuesDescription
spooledMessage awaits in Replix Server outbound queue.
relayedReplix Server forwarded message to configured mailhost.
sentDSN received, mailhost reported the message has been forwarded to next mail server, assuming mailhost does MX resolution, this usually means that mail was relayed to the recipient MX server.
failedDSN received, mailhost reported failure to send the message.
delayedDSN received, mailhost reported the message has been delayed.
sendingMessage in the process of being sent.
AccessNotifyStatusExStringDiagnostic/technical abstract of received DSN, should contain the reason for failure.
AccessNotifyStatusTimeStringate and time the accessed status was updated.
HasMoreResultsIf "ResultLimit" input argument provided and the number of records exceeds the limit, only limited number of records is returned and this result indicates that there were records from the query.

Boolean

ValuesDescription
trueTrue
falseFalse.
ResultsReferencestringA key that is set if there are more messages that meet the search criteria but are not returned in the results. Use this key in the GetNextResults attribute in the subsequent query to retrieve the next set of messages.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmGetSendMessageExt

The SmGetSendMessageExt method retrieves detailed information pertaining to a secure message. Specifically, the note and file list can be returned.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:c01ece56-6efa-4f01-b47d-bf65c40bbb99+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host: qa-10 MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo0znFvjnHQtCiwJKhbFn+gIAAAAArgucBr5rnUynkmBwCieFzHRB27siLuZKjinj5dPMT6MACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmGetSendMessageExt/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmGetSendMessageExt xmlns="http://www.softlinx.com/ReplixFax"> <SmGetSendMessageExtInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <MessageId>8f7d6eecf669ae2128ac8ca979719d04</MessageId> <GetFiles>true</GetFiles> <GetMessageText>true</GetMessageText> </SmGetSendMessageExtInput> </SmGetSendMessageExt> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmGetSendMessageExtResponse> <SmGetSendMessageExtOutput> <Attachment> <AttachmentId>8f7d6eecf669ae2128ac8ca979719d04-1</AttachmentId> <FileName>pages_1.pdf</FileName> <ContentType>application/pdf</ContentType> <FileSize>82183</FileSize> </Attachment> <Attachment> <AttachmentId>8f7d6eecf669ae2128ac8ca979719d04-2</AttachmentId> <FileName>Pages_2.pdf</FileName> <ContentType>application/pdf</ContentType> <FileSize>83360</FileSize> </Attachment> <MessageText>please review</MessageText> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmGetSendMessageExtOutput> </rpx:SmGetSendMessageExtResponse> </soap:Body> </soap:Envelope>

SmGetSendMessageExtInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringUnique identifier of the message details to be retrieved.
GetFilesSet to "true" to retrieve the list of attachments.

Boolean

ValuesDescription
trueTrue
falseFalse.
GetNoteSet to "true" to retrieve the note text.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmGetSendMessageExtOutput

NameTypeDescription
AttachmentList of List of files attached to the message. This will be null if GetFiles was not set to "true".

SmAttachmentInfo

NameTypeDescription
AttachmentIdstring
ContentTypestringMIME type of the attachment. This is optional. If "ContentType" is missing, the file name extension is used to determine the type of document.
FileNamestringFilename of the attachment. This is required. E.g, mydocument.pdf.
FileSize Number of bytes in file.
NotestringNote text. This will be null if GetNote was not set to "true".
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmGetSendMessageAttachment

The SmGetSendMessageAttachment method retrieves the content of a single file. Optionally a zip file containing all files belonging to a single secure message can be retrieved.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:c01ece56-6efa-4f01-b47d-bf65c40bbb99+id=2";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host:
server
MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo03nFvjnHQtCiwJKhbFn+gIAAAAArgucBr5rnUynkmBwCieFzHRB27siLuZKjinj5dPMT6MACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmGetSendMessageAttachment/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmGetSendMessageAttachment xmlns="http://www.softlinx.com/ReplixFax"> <SmGetSendMessageAttachmentInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <AttachmentId>8f7d6eecf669ae2128ac8ca979719d04-1</AttachmentId> </SmGetSendMessageAttachmentInput> </SmGetSendMessageAttachment> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 --5eacef4a0ab3e84d8c18b0942b11cd59.56D895CF.1999AEEC Content-Id: Content-Transfer-Encoding: binary Content-Type: application/xop+xml; charset=utf-8; type="text/xml; charset=utf-8" <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmGetSendMessageAttachmentResponse> <SmGetSendMessageAttachmentOutput> <Attachment> <ContentType>application/pdf</ContentType> <FileName>pages_1.pdf</FileName> <FileContent> <xop:Include href="cid:8f7d6eecf669ae2128ac8ca979719d04-1" /> </FileContent> </Attachment> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmGetSendMessageAttachmentOutput> </rpx:SmGetSendMessageAttachmentResponse> </soap:Body> </soap:Envelope> --5eacef4a0ab3e84d8c18b0942b11cd59.56D895CF.1999AEEC Content-Disposition: attachment; filename="pages_1.pdf" Content-Id: <8f7d6eecf669ae2128ac8ca979719d04-1> Content-Transfer-Encoding: binary Content-Type: application/pdf [binary data]

SmGetSendMessageAttachmentInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
AttachmentIdstringUnique identifier for the file that was attached to the message.
MtomXopIf set to "true", then attachment content will be returned as part of multipart/related message. If set to "false", then the attachment content will be returned inside the SOAP message. Default is "true".

Boolean

ValuesDescription
trueTrue
falseFalse.

SmGetSendMessageAttachmentOutput

NameTypeDescription
AttachmentAttachment details.

SmAttachment

NameTypeDescription
ContentTypestringMIME type of the attachment. This is optional. If "ContentType" is missing, the file name extension is used to determine the type of document.
FileNamestringFilename of the attachment. This is required. E.g, mydocument.pdf.
FileContent base64BinaryContent of the attachment.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmCancelSendMessage

The SmCancelSendMessage cancels a message. If a message is canceled, the recipient will no longer be able to view the contents of the secure message. However, the message will remain in the system until purge occurs. The sender can "undo" a cancel.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:588eeb50-9104-4b9a-9dcd-5bef7d97649e+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host:
server
MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo7/4oD4zLi5Av4uGUO1gJKEAAAAAZ7QeUBYeHEeJ9wbGRWKuRARliyEFnqxNu+ZSbrbINhQACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmCancelSendMessage/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmCancelSendMessage xmlns="http://www.softlinx.com/ReplixFax"> <SmCancelSendMessageInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <MessageId>8f7d6eecf669ae2128ac8ca979719d04</MessageId> <Cancel>true</Cancel> </SmCancelSendMessageInput> </SmCancelSendMessage> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmCancelSendMessageResponse> <SmCancelSendMessageOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmCancelSendMessageOutput> </rpx:SmCancelSendMessageResponse> </soap:Body> </soap:Envelope>

SmCancelSendMessageInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringUnique identifier of the message to cancel or un-cancel.
CancelSet to "true" to cancel the message. Set to "false" to un-cancel the message. If a message is cancelled, the recipient cannot view the message content.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmCancelSendMessageOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmNotifySendMessage

The SmNotifySendMessage method allows the sender to "resend" the email message to the recipient.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:93a697f8-862d-4f5b-9be1-433bbb9a7f3f+id=2";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host:
server
MIME-Version: 1.0 VsDebuggerCausalityData: uIDPozW6VrWQZtFKsiJK2j3n5gkAAAAAR1i5pdU4mk2g4B1FON1tLXum0Qc2R2tOsTc2ba4f0wUACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmNotifySendMessage/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmNotifySendMessage xmlns="http://www.softlinx.com/ReplixFax"> <SmNotifySendMessageInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <MessageId>8f7d6eecf669ae2128ac8ca979719d04</MessageId> </SmNotifySendMessageInput> </SmNotifySendMessage> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmNotifySendMessageResponse> <SmNotifySendMessageOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmNotifySendMessageOutput> </rpx:SmNotifySendMessageResponse> </soap:Body> </soap:Envelope>

SmNotifySendMessageInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringUnique identifier of the message to re-notify.

SmNotifySendMessageOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

Secure Document Recipients Overview

The ReplixDoc API has methods which manage secure document message recipients. A recipient must have a unique email address and password. Any API call that requires SYSTEM credentials are only available to on-premise Replix customers.


SmCreateRecipient

Create a recipient with a specific email address and password. The flag for the recipient to change password can be set during the creation process. However, only the recipient client will enforce this. A Replix user credentials are required to create a recipient. The recipient is created immediately upon successful completion of this request vs. recipient registration.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmCreateRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmCreateRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmCreateRecipientInput xmlns=""> <Authentication> <Login>
username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <Email>
recipient email
</Email> <Name>
recipient name
</Name> <Password>
recipient password
</Password> <MustChangePassword>false</MustChangePassword> <NotifyOnReceive>true</NotifyOnReceive> </SmCreateRecipientInput> </SmCreateRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmCreateRecipientResponse> <SmCreateRecipientOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmCreateRecipientOutput> </rpx:SmCreateRecipientResponse> </soap:Body> </soap:Envelope>

SmCreateRecipientInput

NameTypeDescription
AuthenticationReplix user credentials, not recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail address for the recipient.
NamestringFull name of the recipient.
PasswordstringPassword for the recipient.
MustChangePasswordSet to "1" to have the recipient client force the recipient to change their password.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyOnReceiveIgnored. Reserved for future use.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmCreateRecipientOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmModifyRecipient

Change attributes of an existing recipient, such as email, name, password, and subscription status.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmModifyRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmModifyRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmModifyRecipientInput xmlns=""> <Authentication> <Login>
SYSTEM username or recipient email
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> <Name>
recipient name
</Name> <OldPassword>
recipient password
</OldPassword> <Password>
recipient new password
</Password> </SmModifyRecipientInput> </SmModifyRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmModifyRecipientResponse> <SmModifyRecipientOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmModifyRecipientOutput> </rpx:SmModifyRecipientResponse> </soap:Body> </soap:Envelope>;

SmModifyRecipientInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials or recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail of the recipient to change. If the authentication credentials are the recipient's, then this email address must match the authentication credential email address.
NamestringName of the recipient. Leave empty if name is not changing.
OldPasswordstringExisting recipient password.
PasswordstringNew password.
UpdateLastLogonIf Authentication is SYSTEM, then set this to "true" to have the last logged in time updated to the current time.

Boolean

ValuesDescription
trueTrue
falseFalse.
SubscribeIf Authentication is recipient, then set this to "true" to unsubscribe recipient.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyOnReceiveIgnored. For future use.

Boolean

ValuesDescription
trueTrue
falseFalse.
MustChangePasswordSet this to false if the recipient is changing their password.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmModifyRecipientOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmGetRecipientInfo

Retrieves the current attributes for a recipient such as name and status (i.e. subscribed or unsubscribed).

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmGetRecipientInfo/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmGetRecipientInfo xmlns="http://www.softlinx.com/ReplixFax"> <SmGetRecipientInfoInput xmlns=""> <Authentication> <Login>
SYSTEM username or recipient email
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> </SmGetRecipientInfoInput> </SmGetRecipientInfo> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmGetRecipientInfoResponse> <SmGetRecipientInfoOutput> <Recipient> <Email>recipient@company.com</Email> <Name>Recipient Name</Name> <Status>subscribed</Status> <NotifyOnReceive>true</NotifyOnReceive> <MustChanagePassword>false</MustChanagePassword> </Recipient> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmGetRecipientInfoOutput> </rpx:SmGetRecipientInfoResponse> </soap:Body> </soap:Envelope>

SmGetRecipientInfoInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials or recipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail of the recipient. If the authentication credentials are the recipient's, then this email address must match the authentication credential email address.

SmGetRecipientInfoOutput

NameTypeDescription
RecipientDetails about the recipient.

SmRecipientInfo

NameTypeDescription
EmailstringEmail address that uniquely identifies each recipient
NamestringRecipient name.
LastLogonTimestringLast time the recipient logged into the system using the recipient client application.
StatusRecipient's status.

SmRecipientStatus

ValuesDescription
subscribedRecipient can receive and view messages.
unsubscribedRecipient cannot receive and view messages.
NotifyOnReceiveIgnored.

Boolean

ValuesDescription
trueTrue
falseFalse.
MustChangePasswordIndicates if the recipient client will force a password change.

Boolean

ValuesDescription
trueTrue
falseFalse.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmDeleteRecipient

Removes a recipient from the system. If a recipient is deleted and then added to the system again via SmCreateRecipient or SmInitRegisterRecipient, then the recipient will have access to messages send prior to being deleted.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmDeleteRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmDeleteRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmDeleteRecipientInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>seth.hillman@comcast.net</Email> </SmDeleteRecipientInput> </SmDeleteRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmDeleteRecipientResponse> <SmDeleteRecipientOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmDeleteRecipientOutput> </rpx:SmDeleteRecipientResponse> </soap:Body> </soap:Envelope>

SmDeleteRecipientInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail of the recipient to delete.

SmDeleteRecipientOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmInitUnsubscribeRecipient

A recipient wishes to not receive any emails when a secure message is sent to them. If they are unsubscribed, the recipient is still in the system, but they cannot view any messages sent to them and no email messages will be sent if new secure message requests are made. AN email message is sent to the recipient with an unsubscribe token. The recipient must confirm the unsubscribe request in order for their status to change to "unsubscribed".

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmInitUnsubscribeRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmInitUnsubscribeRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmInitUnsubscribeRecipientInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> </SmInitUnsubscribeRecipientInput> </SmInitUnsubscribeRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmInitUnsubscribeRecipientResponse> <SmInitUnsubscribeRecipientOutput> <UnsubscribeToken>%24v1%24aeece7e03d0c723a264245b376821b0d%246d506275ad9c0b7c6c4714eb%24ed9bee76a3be4ad5d837d48e29cc236ef54c3fe6f220a1de35b5caf84f57a3bc035c099edc3b17a2d911187b51b30ab4d9908dbf13628f30b8def67cf6f9db2326f456e0c5ba3efff51ec29a9d4ad2956cb75b42fed17f2fdc7294e367c360c9a95297d17e9fbb856b0107bed28df1a64b05c2a413fdfae5a39cc026dd1895e2f9dc</UnsubscribeToken> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmInitUnsubscribeRecipientOutput> </rpx:SmInitUnsubscribeRecipientResponse> </soap:Body> </soap:Envelope>

SmInitUnsubscribeRecipientInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail address of recipient.
TokenTTLMinutesNumber of minutes token is valid.

PositiveInt

TypeDescription
stringAn integer greater than 0.

SmInitUnsubscribeRecipientOutput

NameTypeDescription
UnsubscribeTokenstringToken to be used for confirmation.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmConfirmUnsubscribeRecipient

A recipient confirms unsubscribe request. If the recipient decides later to "re-subscribe" then they should register again using SmInitRegisterRecipient.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmConfirmUnsubscribeRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmConfirmUnsubscribeRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmConfirmUnsubscribeRecipientInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> <Token>
token
</Token> </SmConfirmUnsubscribeRecipientInput> </SmConfirmUnsubscribeRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmConfirmUnsubscribeRecipientResponse> <SmConfirmUnsubscribeRecipientOutput> <Email>recipient@company.com</Email> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmConfirmUnsubscribeRecipientOutput> </rpx:SmConfirmUnsubscribeRecipientResponse> </soap:Body> </soap:Envelope>

SmConfirmUnsubscribeRecipientInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail address of the recipient.
TokenstringToken returned by SmInitUnsubscribeRecipient.

SmConfirmUnsubscribeRecipientOutput

NameTypeDescription
EmailstringEmail of recipient.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmInitRegisterRecipient

This call initiates the registration process for a recipient. The recipient provides name and credentials and an email confirmation message is sent to the recipient with a token. The recipient must provide the password and token to SmConfirmRegisterRecipient in order to complete the registration process. The recipient is not in the system until SmConfirmRegisterRecipient is successful.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmInitRegisterRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmInitRegisterRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmInitRegisterRecipientInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> <Name>
recipient name
</Name> <Password>
recipient password
</Password> <NotifyOnReceive>true</NotifyOnReceive> </SmInitRegisterRecipientInput> </SmInitRegisterRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmInitRegisterRecipientResponse> <SmInitRegisterRecipientOutput> <RegistrationToken>%24v1%2412e6e1c50a834c8c3da23ce3e485546c%243b46cb77075b1050dc1db5c7%24397ba879df68460b17a2960539b5577ac3f803e3a0b4d4e120716df37b17e912282c853dc87ce40fd1eabb17e1db84a443e84f55adace993542b1fa75d1d8f5e673c6d3dd78011d417ffac430a5d5ae9968b56afe44725c5988e83daea1943263788ddb1c7de336b1a22edf09358fed962ca9dc28075fab33e6954c9</RegistrationToken> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmInitRegisterRecipientOutput> </rpx:SmInitRegisterRecipientResponse> </soap:Body> </soap:Envelope>

SmInitRegisterRecipientInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail address of the recipient.
NamestringFull name of the recipient.
PasswordstringPassword for the recipient.
NotifyOnReceiveIgnored. For future use.

Boolean

ValuesDescription
trueTrue
falseFalse.
TokenTTLMinutesNumber of minutes token is valid.

PositiveInt

TypeDescription
stringAn integer greater than 0.

SmInitRegisterRecipientOutput

NameTypeDescription
RegistrationTokenstringToken to be used for confirmation.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmConfirmRegisterRecipient

A recipient confirms the registration request by providing the password used when initiating the registration request and the token. Once the recipient is in the system, they can access secure messages sent to them.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmConfirmRegisterRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmConfirmRegisterRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmConfirmRegisterRecipientInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Password>12345678</Password> <Token>
token
</Token> </SmConfirmRegisterRecipientInput> </SmConfirmRegisterRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmConfirmRegisterRecipientResponse> <SmConfirmRegisterRecipientOutput> <Email>recipient@company.com</Email> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmConfirmRegisterRecipientOutput> </rpx:SmConfirmRegisterRecipientResponse> </soap:Body> </soap:Envelope>

SmConfirmRegisterRecipientInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
PasswordstringPassword used in SmInitRegisterRecipient.
TokenstringToken returned by SmInitRegisterRecipient.

SmConfirmRegisterRecipientOutput

NameTypeDescription
EmailstringEmail of recipient.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmInitResetRecipientPassword

Recipient has forgotten their password. This call will send an email message to the recipient with a token.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmInitResetRecipientPassword/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmInitResetRecipientPassword xmlns="http://www.softlinx.com/ReplixFax"> <SmInitResetRecipientPasswordInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> </SmInitResetRecipientPasswordInput> </SmInitResetRecipientPassword> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmInitResetRecipientPasswordResponse> <SmInitResetRecipientPasswordOutput> <ResetToken>%24v1%243cd003281dcf5d7e144a5eb3b59ac7ca%24bf87e93338c358ccf9c0075f%2422c457d1f72f9aa67f583688ab8f6bf271971ea1a32ee59d104af8989e19713c8a0db0af4eebb43bdbd3207ff8cb4836b2af39433b43bb247049f38cbbb14140e341f59bf9f0bf4326b56581d80d817aceaa52d3aed9d458aa4fb1b3</ResetToken> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmInitResetRecipientPasswordOutput> </rpx:SmInitResetRecipientPasswordResponse> </soap:Body> </soap:Envelope>

SmInitResetRecipientPasswordInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail address of recipient.
TokenTTLMinutesNumber of minutes token is valid.

PositiveInt

TypeDescription
stringAn integer greater than 0.

SmInitResetRecipientPasswordOutput

NameTypeDescription
ResetTokenstringToken to be used for confirmation.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmConfirmResetRecipientPassword

The recipient provides the token generated by SmInitResetRecipientPassword and a new password to change their old password.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmConfirmResetRecipientPassword/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmConfirmResetRecipientPassword xmlns="http://www.softlinx.com/ReplixFax"> <SmConfirmResetRecipientPasswordInput xmlns=""> <Authentication> <Login>
SYSTEM username
</Login> <Password>
password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <Email>
recipient email
</Email> <Password>
recipient new password
</Password> <Token>
token
</Token> </SmConfirmResetRecipientPasswordInput> </SmConfirmResetRecipientPassword> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmConfirmResetRecipientPasswordResponse> <SmConfirmResetRecipientPasswordOutput> <Email>recipient@company.com</Email> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmConfirmResetRecipientPasswordOutput> </rpx:SmConfirmResetRecipientPasswordResponse> </soap:Body> </soap:Envelope>

SmConfirmResetRecipientPasswordInput

NameTypeDescription
AuthenticationReplix SYSTEM user credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
EmailstringEmail address of the recipient.
PasswordstringNew recipient password.
TokenstringToken returned by SmInitResetRecipientPassword.

SmConfirmResetRecipientPasswordOutput

NameTypeDescription
EmailstringEmail of recipient.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmLoginRecipient

Recipient can use this API to validate their credentials and obtain an authorization token to be used in future API calls. When the token expires future API wills will fail. The recipient's last login time will be updated when this call is used.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmLoginRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmLoginRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmLoginRecipientInput xmlns=""> <Authentication> <Login>
recipient email
</Login> <Password>
recipient password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> </SmLoginRecipientInput> </SmLoginRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmLoginRecipientResponse> <SmLoginRecipientOutput> <AuthToken>q+qv7UnAbpsR8MGNqjwEHsifklSBJb2eEDvKxsIuedk=</AuthToken> <MustChangePassword>false</MustChangePassword> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmLoginRecipientOutput> </rpx:SmLoginRecipientResponse> </soap:Body> </soap:Envelope>

SmLoginRecipientInput

NameTypeDescription
AuthenticationRecipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.

SmLoginRecipientOutput

NameTypeDescription
AuthTokenstringString that contains token if credentials were validated.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.
MustChangePasswordSet to "true" if recipient should change their password. This is not enforced by the system. The client application must enforce if desired.
UserNamestringName of recipient.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmLogoutRecipient

Invalidates the authorization token obtained by SmLoginRecipient.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmLogoutRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmLogoutRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmLogoutRecipientInput xmlns=""> <AuthenticationToken> <AuthToken>
auth token
</AuthToken> </AuthenticationToken> </SmLogoutRecipientInput> </SmLogoutRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmLogoutRecipientResponse> <SmLogoutRecipientOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmLogoutRecipientOutput> </rpx:SmLogoutRecipientResponse> </soap:Body> </soap:Envelope>

SmLogoutRecipientInput

NameTypeDescription
AuthTokenstringString that contains token if credentials were validated.

SmLogoutRecipientOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmLogoutRecipient

Invalidates the authorization token obtained by SmLoginRecipient.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=SmLogoutRecipient/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmLogoutRecipient xmlns="http://www.softlinx.com/ReplixFax"> <SmLogoutRecipientInput xmlns=""> <AuthenticationToken> <AuthToken>
auth token
</AuthToken> </AuthenticationToken> </SmLogoutRecipientInput> </SmLogoutRecipient> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmLogoutRecipientResponse> <SmLogoutRecipientOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmLogoutRecipientOutput> </rpx:SmLogoutRecipientResponse> </soap:Body> </soap:Envelope>

SmLogoutRecipientInput

NameTypeDescription
AuthTokenstringString that contains token if credentials were validated.

SmLogoutRecipientOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

Received Secure Document Messages Overview

The ReplixDoc API has methods which allow the recipient of a secure document message to view the content of the message and attached files.

For cloud customers, Softlinx provides a test recipient portal to access received secure document messages: https://faxtest.softlinx.com:82


SmQueryRecvMessage

Searches for received messages based on criteria.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:93dc064f-369e-4acf-80d0-80f5a7390c82+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host: qa-10 MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo0fb6M5Ph5hErJv9gBLjxbsAAAAA06nxNzCocki/jwrNZlnaCCJ9S83zMitGkgH6lAm7igEACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmQueryRecvMessage/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmQueryRecvMessage xmlns="http://www.softlinx.com/ReplixFax"> <SmQueryRecvMessageInput xmlns=""> <Authentication> <Login>
recipient email
</Login> <Password>
recipient password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <SortOrder>desc</SortOrder> <ResultLimit>10</ResultLimit> <DatetimeAfter>
datetime
</DatetimeAfter> </SmQueryRecvMessageInput> </SmQueryRecvMessage> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmQueryRecvMessageResponse> <SmQueryRecvMessageOutput> <Message> <MessageId>ec91f7f4cbdab005976e067654efb0c6</MessageId> <RecipientEmail>recipient@acme.com</RecipientEmail> <SenderEmail>sender@company.comlt;/SenderEmail> <Subject>This is a secure email from Joe</Subject> <ReceivedTime>2016-03-03T18:13:02Z</ReceivedTime> <Mark>false</Mark> </Message> <HasMoreResults>true</HasMoreResults> <ResultsReference>TGFzdFJlY0lkPTIwMTYtMDMtMDNUMTMlM0ExMyUzQTAyJTJDMTk5ODQ7UmVzdWx0TGltaXQ9MTtfdGltZT0yMDE2LTAzLTA0VDE2JTNBMTklM0E0OVo=</ResultsReference> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmQueryRecvMessageOutput> </rpx:SmQueryRecvMessageResponse> </soap:Body> </soap:Envelope>

SmQueryRecvMessageInput

 
NameTypeDescription
AuthenticationRecipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringLimit the search results to a single message.
MarkLimit the search results based on the mark value of "true" or "false".

Boolean

ValuesDescription
trueTrue
falseFalse.
ReservedDM1If set to "false", then only return messages that were not receieved by the delivery manager.

Boolean

ValuesDescription
trueTrue
falseFalse.
SortOrderOrder of the search results.

QuerySortOrder

ValuesDescription
ascSort ascending.
descSort descending.
ResultLimitLimit the number of messages returned in the search.

PositiveInt

TypeDescription
stringAn integer greater than 0.
GetNextResultsstringIf a query was issued with the ResultLimit set and the results HasMoreResults is "true", then there are more results that match the criteria. To get to the next set of messages, reissue the query, but set GetNextResults to the value returned in the ResultsReference attribute. If GetNextResults is set, then any changes to the original search criteria on subsequent queries is ignored, except for ResultLimit. In other words, if GetNextResults is set, you cannot alter the query when getting the next set of messages, except for the number of messages to return
DatetimeAfterLimit the search results to messages sent after this datetime.

datetime

Description

The valid formats for date/time parameters are a subset of the ISO 8601 specification:

YYYY-MM-DDThh:mmTZ or YYYY-MM-DDThh:mm:ssTZ, where TZ is the time zone and the format of this is either "Z" or (+|-)hh:mm. The “:” between the hour and minutes in the time zone is optional. Examples are:

  • 2010-01-31T13:30:45Z "Z" stands for GMT time zone
  • 2010-01-31T14:30:45+01:00
  • 2010-01-31T13:30:45-0500
DatetimeBeforeLimit the search results to messages sent before this datetime.

datetime

Description

The valid formats for date/time parameters are a subset of the ISO 8601 specification:

YYYY-MM-DDThh:mmTZ or YYYY-MM-DDThh:mm:ssTZ, where TZ is the time zone and the format of this is either "Z" or (+|-)hh:mm. The “:” between the hour and minutes in the time zone is optional. Examples are:

  • 2010-01-31T13:30:45Z "Z" stands for GMT time zone
  • 2010-01-31T14:30:45+01:00
  • 2010-01-31T13:30:45-0500

SmQueryRecvMessageOutput

NameTypeDescription
MessageList of Information about the Messages created.

SmRecvMessageDetail

NameTypeDescription
MessageIdstringUnique identifier of a message.
RecipientEmailstringEmail address of the recipient.
SenderEmailstringEmail address of the sender.
SenderNamestringName of the sender.
SubjectstringSubject text sender entered.
AttachmentCount Number of files attached to message.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
ReceivedTimestringDate and time secure document message was received.
AccessTimestringDate and time recipient accessed the content of the secure message.
MarkIndicator whether recipient has marked message.

Boolean

ValuesDescription
trueTrue
falseFalse.
ExpireTimestringDate and time message will be available to be removed form the system.
HasMoreResultsIf "ResultLimit" input argument provided and the number of records exceeds the limit, only limited number of records is returned and this result indicates that there were records from the query.

Boolean

ValuesDescription
trueTrue
falseFalse.
ResultsReferencestringA key that is set if there are more messages that meet the search criteria but are not returned in the results. Use this key in the GetNextResults attribute in the subsequent query to retrieve the next set of messages.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmGetRecvMessageExt

Retrieves additional information about the message, such as note and files.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:93dc064f-369e-4acf-80d0-80f5a7390c82+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host: qa-10 MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo0fb6M5Ph5hErJv9gBLjxbsAAAAA06nxNzCocki/jwrNZlnaCCJ9S83zMitGkgH6lAm7igEACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmGetRecvMessageExt/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmGetRecvMessageExt xmlns="http://www.softlinx.com/ReplixFax"> <SmGetRecvMessageExtInput xmlns=""> <Authentication> <Login>
recipient email
</Login> <Password>
recipient password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <MessageId>
message id
</MessageId> <GetFiles>true</GetFiles> <GetMessageText>true</GetMessageText> </SmGetRecvMessageExtInput> </SmGetRecvMessageExt> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501BE21.1B1B8E79 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmGetRecvMessageExtResponse> <SmGetRecvMessageExtOutput> <Attachment> <AttachmentId>ec91f7f4cbdab005976e067654efb0c6-1</AttachmentId> <FileName>Report.xlsx</FileName> <ContentType>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</ContentType> <FileSize>7436</FileSize> </Attachment> <MessageText>This is the report.</MessageText> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmGetRecvMessageExtOutput> </rpx:SmGetRecvMessageExtResponse> </soap:Body> </soap:Envelope>

SmGetRecvMessageExtInput

NameTypeDescription
AuthenticationRecipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringUnique identifier of the message.
GetFilesSet to "true" to retrieve the list of attachments.

Boolean

ValuesDescription
trueTrue
falseFalse.
GetNoteSet to "true" to retrieve the note text.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmGetRecvMessageExtOutput

NameTypeDescription
AttachmentList of Information about the secure messages.

SmAttachmentInfo

NameTypeDescription
AttachmentIdstring
ContentTypestringMIME type of the attachment. This is optional. If "ContentType" is missing, the file name extension is used to determine the type of document.
FileNamestringFilename of the attachment. This is required. E.g, mydocument.pdf.
FileSize Number of bytes in file.
NotestringNote text that was specified by the sender.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmGetRecvMessageAttachment

Retreives the file content of an attachment.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:93dc064f-369e-4acf-80d0-80f5a7390c82+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host: qa-10 MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo0fb6M5Ph5hErJv9gBLjxbsAAAAA06nxNzCocki/jwrNZlnaCCJ9S83zMitGkgH6lAm7igEACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmGetRecvMessageAttachment/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmGetRecvMessageAttachment xmlns="http://www.softlinx.com/ReplixFax"> <SmGetRecvMessageAttachmentInput xmlns=""> <Authentication> <Login>
recipient email
</Login> <Password>
recipient password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <AttachmentId>
attachment id
</AttachmentId> </SmGetRecvMessageAttachmentInput> </SmGetRecvMessageAttachment> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml"; boundary="5eacef4a0ab3e84d8c18b0942b11cd59.56D9B94E.446C8353"; start="<elvis1@graceland.elvis>>"; start-info="text/xml; charset=utf-8" X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.56D9B94E.446C8353 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmGetRecvMessageAttachmentResponse> <SmGetRecvMessageAttachmentOutput> <Attachment> <ContentType>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</ContentType> <FileName>Showcase.xlsx</FileName> <FileContent> <xop:Include href="cid:ec91f7f4cbdab005976e067654efb0c6-1" /> </FileContent> </Attachment> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmGetRecvMessageAttachmentOutput> </rpx:SmGetRecvMessageAttachmentResponse> </soap:Body> </soap:Envelope> --5eacef4a0ab3e84d8c18b0942b11cd59.56D9B94E.446C8353 Content-Disposition: attachment; filename="Showcase.xlsx" Content-Id: <ec91f7f4cbdab005976e067654efb0c6-1>gt; Content-Transfer-Encoding: binary Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet [binary data ...]

SmGetRecvMessageAttachmentInput

NameTypeDescription
AuthenticationRecipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
AttachmentIdstringUnique identifier for the file that was attached to the message. If message ID is used, then a zip file is returned containing all attachments for the message.
MtomXopIf set to "true", then attachment content will be returned as part of multipart/related message. If set to "false", then the attachment content will be returned inside the SOAP message. Default is "true".

Boolean

ValuesDescription
trueTrue
falseFalse.

SmGetRecvMessageAttachmentOutput

NameTypeDescription
AttachmentDetails about the attachment.

SmAttachment

NameTypeDescription
ContentTypestringMIME type of the attachment. This is optional. If "ContentType" is missing, the file name extension is used to determine the type of document.
FileNamestringFilename of the attachment. This is required. E.g, mydocument.pdf.
FileContent base64BinaryContent of the attachment.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

SmModifyRecvMessage

Change attributes of a received message.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml";start="";boundary="uuid:93dc064f-369e-4acf-80d0-80f5a7390c82+id=1";start-info="text/xml" Accept-Encoding: gzip, deflate Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Expect: 100-continue Host: qa-10 MIME-Version: 1.0 VsDebuggerCausalityData: uIDPo0fb6M5Ph5hErJv9gBLjxbsAAAAA06nxNzCocki/jwrNZlnaCCJ9S83zMitGkgH6lAm7igEACQAA SOAPAction: "http://www.softlinx.com/wsapi/op=SmModifyRecvMessage/ver=43" <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SmModifyRecvMessage xmlns="http://www.softlinx.com/ReplixFax"> <SmModifyRecvMessageInput xmlns=""> <Authentication> <Login>
recipient email
</Login> <Password>
recipient password
</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm /> </Authentication> <MessageId>ec91f7f4cbdab005976e067654efb0c6</MessageId> <Mark>true</Mark> </SmModifyRecvMessageInput> </SmModifyRecvMessage> </s:Body> </s:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: multipart/related; type="application/xop+xml"; boundary="5eacef4a0ab3e84d8c18b0942b11cd59.56D9B94E.446C8353"; start="<elvis1@graceland.elvis>>"; start-info="text/xml; charset=utf-8" X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.56D9B94E.446C8353 <?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rpx="http://www.softlinx.com/ReplixFax" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <rpx:SmModifyRecvMessageResponse> <SmModifyRecvMessageOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText /> </RequestStatus> </SmModifyRecvMessageOutput> </rpx:SmModifyRecvMessageResponse> </soap:Body> </soap:Envelope>

SmModifyRecvMessageInput

NameTypeDescription
AuthenticationRecipient credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
MessageIdstringUnique identifier for the message.
UpdateAccessTimeSet to "true" to update the accessed time. If the sender requested to get notified when the message is accessed, then an email will be send to the sender.

Boolean

ValuesDescription
trueTrue
falseFalse.
MarkSet to "true" to "mark" the message. This allows querying for unmarked messages if there is a need to see "new" messages.

Boolean

ValuesDescription
trueTrue
falseFalse.

SmModifyRecvMessageOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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.


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.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== 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>

Output:


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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
PhoneBookEntryInfoDetails of the phonebook entry.

PhoneBookEntryInfo

NameTypeDescription
IdstringUnique ID for phonebook entry. This will be assigned by Softlinx Cloud Fax.
NamestringName of person associated with phonebook entry.
FaxNumberstringFax number.
CompanystringCompany name.
AddressstringAddress of person or company.
TitlestringBusiness title of person.
PhoneNumberstringPhone number associated with entry.
EmailAddressstringEmail address of person.
BookIdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.

AddPhoneBookEntryOutput

NameTypeDescription
IdstringId of the new phonebook entry.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
PhoneBookEntryInfoDetails of the phonebook entry.

PhoneBookEntryInfo

NameTypeDescription
IdstringUnique ID for phonebook entry. This will be assigned by Softlinx Cloud Fax.
NamestringName of person associated with phonebook entry.
FaxNumberstringFax number.
CompanystringCompany name.
AddressstringAddress of person or company.
TitlestringBusiness title of person.
PhoneNumberstringPhone number associated with entry.
EmailAddressstringEmail address of person.
IdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.
BookIdstringId of entry to update.

ModifyPhoneBookEntryOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
BookIdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.
IdstringId of entry to delete.

DeletePhoneBookEntryOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
BookIdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.
IdstringId of entry to search for.
GroupIdstringId of phonebook group to search for.
ResultLimitLimit number of records returned to a specific amount.

PositiveInt

TypeDescription
stringAn integer greater than 0.
NextResultIf a query was issued with the ResultLimit set and the results HasMoreResults is "true", then there are more results that match the criteria. To get to the next set of entries, reissue the query, but set GetNextResults to the value returned in the ResultsReference attribute. If GetNextResults is set, then any changes to the original search criteria on subsequent queries is ignored, except for ResultLimit. In other words, if GetNextResults is set, you cannot alter the query when getting the next set of entries, except for the number of entries to return.

Boolean

ValuesDescription
trueTrue
falseFalse.
PrevResultContextstringContext id that was returned from a previous query phonebook call.

QueryPhoneBookEntryOutput

NameTypeDescription
PhoneBookEntryInfoList of Entries that meet criteria.

PhoneBookEntryInfo

NameTypeDescription
IdstringUnique ID for phonebook entry. This will be assigned by Softlinx Cloud Fax.
NamestringName of person associated with phonebook entry.
FaxNumberstringFax number.
CompanystringCompany name.
AddressstringAddress of person or company.
TitlestringBusiness title of person.
PhoneNumberstringPhone number associated with entry.
EmailAddressstringEmail address of person.
HasMoreResultsBoolean that indicates if there are more results to return.

Boolean

ValuesDescription
trueTrue
falseFalse.
ResultContextstringContext id that can be used to return partial results for a phonebook.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
PhoneBookGroupInfoDetails of the phonebook group.

PhoneBookGroupInfo

NameTypeDescription
IdstringUnique ID for phonebook group. This will be assigned by Softlinx Cloud Fax.
NamestringName of phonebook group.
BookIdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.

AddPhonebookGroupOutput

NameTypeDescription
IdstringID of the group created.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
PhoneBookGroupInfoDetails of the phonebook group.

PhoneBookGroupInfo

NameTypeDescription
IdstringUnique ID for phonebook group. This will be assigned by Softlinx Cloud Fax.
NamestringName of phonebook group.
BookIdstringSpecify "*" for the global phonebook.
IdstringId of group to update.

ModifyPhoneBookGroupOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
BookIdstringSpecify "*" for the global phonebook.
IdstringId of group to find. Leave blank to get all groups.
ResultLimitMaximum number of results to return. If not set, all rows are returned and result context is not used.

PositiveInt

TypeDescription
stringAn integer greater than 0.
NextResultSet to true if PrevResultContext is set.

Boolean

ValuesDescription
trueTrue
falseFalse.
PrevResultContextstringContext id that was returned from a previous query phonebook group call.

QueryPhoneBookGroupOutput

NameTypeDescription
PhoneBookGroupInfoList of Entries that meet criteria.

PhoneBookGroupInfo

NameTypeDescription
IdstringUnique ID for phonebook group. This will be assigned by Softlinx Cloud Fax.
NamestringName of phonebook group.
HasMoreResultsBoolean that indicates if there are more results to return.

Boolean

ValuesDescription
trueTrue
falseFalse.
ResultContextstringContext id that can be used to return partial results for a phonebook.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
BookIdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.
EntryIdstringId of phonebook entry to add as a member to group.
GroupIdstringId of the phonebook group

AddPhonebookGroupEntryOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
BookIdstringSpecify "*" for the global phonebook. Otherwise leave empty and the user's personal phonebook will be used.
EntryIdstringId of phonebook entry to remove.
GroupIdstringId of the phonebook group.

DeletePhonebookGroupEntryOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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.


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.

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== 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>

Output:

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
DepartmentInfoDepartment attributes.

DepartmentInfo

NameTypeDescription
IdstringUnique ID for a Softlinx Cloud Fax department.
NamestringDepartment name
ProjectCodestringApplication specific string. If set, this will overwrite the account number associated with the user.
ProjectCode2stringApplication specific string, aka reference keyword.
DialPrefixstringNumber to dial before specified fax number.
PageOrientationSpecify the orientation of data on imaged pages for un-paginated input. Applies to text attachments.

PageOrientation

ValuesDescription
landscapeAll pages are landscape in document.
portraitAll pages are portrait in document.
FaxHeaderstring containing Indicates content of fax header. Will only be used is FaxHeaderEnabled is set to true. The Fax Header can contains static text and keywords that are replaced with real data. The default fax header format is date/time + TSI + pages.

Fax Header Keywords

Keywords are case sensitive.

ValuesDescription
%t% character
%tTime
%dDate
%PPage number
%pTotal pages
%iSender TSI
%jSender name
%kSender DID (fax number)
%lSender telephone number
%mSender email
%nSend job id
%aRecipient name
%bRecipient company name
%cRecipient title
%eRecipient fax number
%fRecipient telephone number
%CNCover page field with field id N, N is a number, eg %C333 to insert cover page 333
FaxHeaderEnabled Used to indicate if the fax header should be included in the fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PaperSizereserved

PaperSize

ValuesDescription
LetterAll pages are letter size in document.
LegalAll pages are Legal size in document.
A4All pages are A4 size in document.
B4All pages are B4 size in document.
CountryCodestringreserved
CoverPageNamestringMust be a valid cover page name template name. Use EnumerateCoverPages to list available cover page templates.
CpCompanyNamestringCompany Name (optionally used in Cover page).
CpAddress1stringAddress Line (optionally used in Cover page).
CpAddress2stringAddress Line (optionally used in Cover page).
TSIstring

TSI and CSI

TSI (Transmitting Station Identifier) is a string that a sending fax machine sends to the receiving fax machine. The receiving fax machine usually displays this value on the fax machines LCD display.

CSI (Called Station Identifier) is a string that a receiving fax machine sends to the sending fax machine. The sending fax machine usually displays this string on the fax machines LCD display.

TSI and CSI are transmitted during initial stage of the fax protocol negotiation

Prioritystringreserved
RetryCountstringNumber of times to attempt to send the fax.
RetryIntervalstringNumber of minutes between attempts to send the fax.
DeleteAfterSendIf "true" then the fax is deleted after it is successfully sent.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
EmailAddressstringEmail address used for fax notifications when receiving a fax.
ReceiveFaxNotifySet to "true" if you want recipient to receive an email when a fax is received.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxNotifyAttachSet to "true" if you want the fax to be attached in the email notification..

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedAttachUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PrinterNamestringreserved
SendPreFilterstringreserved
SendPostFilterstringreserved
ReceiveFaxFilterstringreserved
ReservedWCstringreserved
NotifyUrlstringURL to post HTTP information about incoming and outgoing faxes.
NotifyUrlSendIndicates whether to sent HTTP posts to the NotifyURL for outbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUrlRecvIndicates whether to sent HTTP posts to the NotifyURL for inbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.

AddDepartmentOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
DepartmentInfoDepartment attributes to change.

DepartmentInfo

NameTypeDescription
IdstringUnique ID for a Softlinx Cloud Fax department.
NamestringDepartment name
ProjectCodestringApplication specific string. If set, this will overwrite the account number associated with the user.
ProjectCode2stringApplication specific string, aka reference keyword.
DialPrefixstringNumber to dial before specified fax number.
PageOrientationSpecify the orientation of data on imaged pages for un-paginated input. Applies to text attachments.

PageOrientation

ValuesDescription
landscapeAll pages are landscape in document.
portraitAll pages are portrait in document.
FaxHeaderstring containing Indicates content of fax header. Will only be used is FaxHeaderEnabled is set to true. The Fax Header can contains static text and keywords that are replaced with real data. The default fax header format is date/time + TSI + pages.

Fax Header Keywords

Keywords are case sensitive.

ValuesDescription
%t% character
%tTime
%dDate
%PPage number
%pTotal pages
%iSender TSI
%jSender name
%kSender DID (fax number)
%lSender telephone number
%mSender email
%nSend job id
%aRecipient name
%bRecipient company name
%cRecipient title
%eRecipient fax number
%fRecipient telephone number
%CNCover page field with field id N, N is a number, eg %C333 to insert cover page 333
FaxHeaderEnabled Used to indicate if the fax header should be included in the fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PaperSizereserved

PaperSize

ValuesDescription
LetterAll pages are letter size in document.
LegalAll pages are Legal size in document.
A4All pages are A4 size in document.
B4All pages are B4 size in document.
CountryCodestringreserved
CoverPageNamestringMust be a valid cover page name template name. Use EnumerateCoverPages to list available cover page templates.
CpCompanyNamestringCompany Name (optionally used in Cover page).
CpAddress1stringAddress Line (optionally used in Cover page).
CpAddress2stringAddress Line (optionally used in Cover page).
TSIstring

TSI and CSI

TSI (Transmitting Station Identifier) is a string that a sending fax machine sends to the receiving fax machine. The receiving fax machine usually displays this value on the fax machines LCD display.

CSI (Called Station Identifier) is a string that a receiving fax machine sends to the sending fax machine. The sending fax machine usually displays this string on the fax machines LCD display.

TSI and CSI are transmitted during initial stage of the fax protocol negotiation

Prioritystringreserved
RetryCountstringNumber of times to attempt to send the fax.
RetryIntervalstringNumber of minutes between attempts to send the fax.
DeleteAfterSendIf "true" then the fax is deleted after it is successfully sent.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
EmailAddressstringEmail address used for fax notifications when receiving a fax.
ReceiveFaxNotifySet to "true" if you want recipient to receive an email when a fax is received.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxNotifyAttachSet to "true" if you want the fax to be attached in the email notification..

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedAttachUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PrinterNamestringreserved
SendPreFilterstringreserved
SendPostFilterstringreserved
ReceiveFaxFilterstringreserved
ReservedWCstringreserved
NotifyUrlstringURL to post HTTP information about incoming and outgoing faxes.
NotifyUrlSendIndicates whether to sent HTTP posts to the NotifyURL for outbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUrlRecvIndicates whether to sent HTTP posts to the NotifyURL for inbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
DepartmentNamestringName of department to change.

ModifyDepartmentOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
DepartmentNamestringName of department to delete.

DeleteDepartmentOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

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

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
DepartmentNamestringName of department to search for.
ResultLimitMaximum number of departments to return.

PositiveInt

TypeDescription
stringAn integer greater than 0.
NextResultIf "true:", then only departments where DepartmentID is greater than the DepartmentID specified will be returned.

QueryDepartmentOutput

NameTypeDescription
HasMoreResultsWill be "true" if ResultLimit was set to "true" and not all of the remaining departments were returned.

Boolean

ValuesDescription
trueTrue
falseFalse.
DepartmentInfoList of Department metadata.

DepartmentInfo

NameTypeDescription
IdstringUnique ID for a Softlinx Cloud Fax department.
NamestringDepartment name
ProjectCodestringApplication specific string. If set, this will overwrite the account number associated with the user.
ProjectCode2stringApplication specific string, aka reference keyword.
DialPrefixstringNumber to dial before specified fax number.
PageOrientationSpecify the orientation of data on imaged pages for un-paginated input. Applies to text attachments.

PageOrientation

ValuesDescription
landscapeAll pages are landscape in document.
portraitAll pages are portrait in document.
FaxHeaderstring containing Indicates content of fax header. Will only be used is FaxHeaderEnabled is set to true. The Fax Header can contains static text and keywords that are replaced with real data. The default fax header format is date/time + TSI + pages.

Fax Header Keywords

Keywords are case sensitive.

ValuesDescription
%t% character
%tTime
%dDate
%PPage number
%pTotal pages
%iSender TSI
%jSender name
%kSender DID (fax number)
%lSender telephone number
%mSender email
%nSend job id
%aRecipient name
%bRecipient company name
%cRecipient title
%eRecipient fax number
%fRecipient telephone number
%CNCover page field with field id N, N is a number, eg %C333 to insert cover page 333
FaxHeaderEnabled Used to indicate if the fax header should be included in the fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PaperSizereserved

PaperSize

ValuesDescription
LetterAll pages are letter size in document.
LegalAll pages are Legal size in document.
A4All pages are A4 size in document.
B4All pages are B4 size in document.
CountryCodestringreserved
CoverPageNamestringMust be a valid cover page name template name. Use EnumerateCoverPages to list available cover page templates.
CpCompanyNamestringCompany Name (optionally used in Cover page).
CpAddress1stringAddress Line (optionally used in Cover page).
CpAddress2stringAddress Line (optionally used in Cover page).
TSIstring

TSI and CSI

TSI (Transmitting Station Identifier) is a string that a sending fax machine sends to the receiving fax machine. The receiving fax machine usually displays this value on the fax machines LCD display.

CSI (Called Station Identifier) is a string that a receiving fax machine sends to the sending fax machine. The sending fax machine usually displays this string on the fax machines LCD display.

TSI and CSI are transmitted during initial stage of the fax protocol negotiation

Prioritystringreserved
RetryCountstringNumber of times to attempt to send the fax.
RetryIntervalstringNumber of minutes between attempts to send the fax.
DeleteAfterSendIf "true" then the fax is deleted after it is successfully sent.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
EmailAddressstringEmail address used for fax notifications when receiving a fax.
ReceiveFaxNotifySet to "true" if you want recipient to receive an email when a fax is received.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxNotifyAttachSet to "true" if you want the fax to be attached in the email notification..

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedAttachUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PrinterNamestringreserved
SendPreFilterstringreserved
SendPostFilterstringreserved
ReceiveFaxFilterstringreserved
ReservedWCstringreserved
NotifyUrlstringURL to post HTTP information about incoming and outgoing faxes.
NotifyUrlSendIndicates whether to sent HTTP posts to the NotifyURL for outbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUrlRecvIndicates whether to sent HTTP posts to the NotifyURL for inbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

Users Overview

A Replix user can send and receive faxes and/or send secure documents.


AddUser

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

Input:

Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host:
server
User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=AddUser/ver=19" <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:AddUser xmlns:ns2="http://www.softlinx.com/ReplixFax"> <AddUserInput> <Authentication> <Login>
username
</Login> <Password>
password
d</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <UserInfo> <UserId>jdoe</UserId> <Name>John Doe</Name> <Password>mypass</Password> </UserInfo> </AddUserInput> </ns2:AddUser> </S:Body> </S:Envelope>

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502D626.75AEB88 <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:AddUserResponse> <AddUserOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </AddUserOutput> </rpx:AddUserResponse> </soap:Body> </soap:Envelope>

AddUserInput

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
UserInfoUser attributes.

UserInfo

NameTypeDescription
UserIdstringUnique ID for a Softlinx Cloud Fax user. Used to log into portal.
NamestringUser's Name
NativeUserIdstringreserved
PasswordstringUser's password.
FaxNumberstringDID number. When faxes are received at this number, they will get routed to this user.
DepartmentIdstringOnly set if a user is a member of a department. Use QueryDepartment to obtain valid department IDs.
ProjectCodestringApplication specific string. This is the account number associated with the user. Any faxes sent out by this user will have this accout unless overwritten during the send.
ProjectCode2stringApplication specific string. This is the default keywords associated with the user. Any faxes sent out by this user will have these keywords unless overwritten during the send.
DialPrefixstringreserved
PageOrientationreserved

PageOrientation

ValuesDescription
landscapeAll pages are landscape in document.
portraitAll pages are portrait in document.
PaperSizereserved

PaperSize

ValuesDescription
LetterAll pages are letter size in document.
LegalAll pages are Legal size in document.
A4All pages are A4 size in document.
B4All pages are B4 size in document.
CountryCodestringreserved
ProxyUserreserved

Boolean

ValuesDescription
trueTrue
falseFalse.
AllowAdminApireserved

Boolean

ValuesDescription
trueTrue
falseFalse.
CoverPageNamestringMust be a valid cover page name template name. Use EnumerateCoverPages to list available cover page templates.
CpTitlestringJob title. (optionally used in Cover page).
CpCompanyNamestringCompany Name (optionally used in Cover page).
CpAddress1stringAddress Line (optionally used in Cover page).
CpAddress2stringAddress Line (optionally used in Cover page).
CpVoiceNumberstringPhone Number (optionally used in Cover page).
CpEmailstringEmail address. (optionally used in Cover page).
TSIstring

TSI and CSI

TSI (Transmitting Station Identifier) is a string that a sending fax machine sends to the receiving fax machine. The receiving fax machine usually displays this value on the fax machines LCD display.

CSI (Called Station Identifier) is a string that a receiving fax machine sends to the sending fax machine. The sending fax machine usually displays this string on the fax machines LCD display.

TSI and CSI are transmitted during initial stage of the fax protocol negotiation

Prioritystringreserved
RetryCountstringNumber of times to attempt to send the fax.
RetryIntervalstringNumber of minutes between attempts to send the fax.
DeleteAfterSendIf "true"then the fax is deleted after it is successfully sent.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
EmailAddressstringEmail address used for fax notifications when receiving a fax.
ReceiveFaxNotifySet to "true"if you want recipient to receive an email when a fax is received.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxNotifyAttachSet to "true" if you want the fax to be attached in the email notification.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedAttachUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PrinterNamestringreserved
SendPreFilterstringreserved
SendPostFilterstringreserved
ReceiveFaxFilterstringreserved
SentPagesreserved

Int

TypeDescription
stringA positive or negative integer.
SentPagesThresholdreserved

Int

TypeDescription
stringA positive or negative integer.
ReceivedPagesreserved

Int

TypeDescription
stringA positive or negative integer.
ReceivedPagesThresholdreserved

Int

TypeDescription
stringA positive or negative integer.
CoverPageNameDefaultstring
ReservedWCstringreserved
FaxHeaderstring containing Indicates content of fax header. Will only be used is FaxHeaderEnabled is set to true. The Fax Header can contains static text and keywords that are replaced with real data. The default fax header format is date/time + TSI + pages.

Fax Header Keywords

Keywords are case sensitive.

ValuesDescription
%t% character
%tTime
%dDate
%PPage number
%pTotal pages
%iSender TSI
%jSender name
%kSender DID (fax number)
%lSender telephone number
%mSender email
%nSend job id
%aRecipient name
%bRecipient company name
%cRecipient title
%eRecipient fax number
%fRecipient telephone number
%CNCover page field with field id N, N is a number, eg %C333 to insert cover page 333
FaxHeaderEnabled Used to indicate if the fax header should be included in the fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ScanBarcodeCheck for barcodes in inbound faxes. Barcode service must be enabled in order for this to work.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
M2fIgnoreSubjectIgnore the subject of the email message when sending email to fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
M2fIgnoreBodyIgnore the body of the email message when sending email to fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ParentUserIdstringignored
SendEnabledAllow user to be able to send a fax.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifySmAccessReceive email notification if a send secure document message was accessed by the recipient.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
AllowSmApiAllow user to perform secure document message features such as sending a message.

Boolean

ValuesDescription
trueTrue
falseFalse.
SendFaxNotifySuccessAttachAttach fax after a successful send.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SmRecipientRefstringEmail of recipient that user is liked to. This field is read only.
SmRecipientRefIsValidIndicates if the recipient link is valid. If the recipient changes their password then the link will become invalid. This field is read only.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyUrlstringURL to post HTTP information about incoming and outgoing faxes.
NotifyUrlSendIndicates whether to sent HTTP posts to the NotifyURL for outbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUrlRecvIndicates whether to sent HTTP posts to the NotifyURL for inbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUserOptionally send a welcome email message to the user.

Boolean

ValuesDescription
trueTrue
falseFalse.

AddUserOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

ModifyUser

The ModifyUser method is a SOAP request for updating a new Softlinx Cloud user. When the API call returns, the results will indicate whether the new user was successfully updated. Only users with the "Allow Admin API" privilege can modify other users. Any user can modify their own attributes except: Name, NativeUserId, FaxNumber, CountryCode, ProxyUser, Admin API Enabled, EmailAddress, and filters.

ModifyUserInput

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
UserInfoUser attributes to change.

UserInfo

NameTypeDescription
UserIdstringUnique ID for a Softlinx Cloud Fax user. Used to log into portal.
NamestringUser's Name
NativeUserIdstringreserved
PasswordstringUser's password.
FaxNumberstringDID number. When faxes are received at this number, they will get routed to this user.
DepartmentIdstringOnly set if a user is a member of a department. Use QueryDepartment to obtain valid department IDs.
ProjectCodestringApplication specific string. This is the account number associated with the user. Any faxes sent out by this user will have this accout unless overwritten during the send.
ProjectCode2stringApplication specific string. This is the default keywords associated with the user. Any faxes sent out by this user will have these keywords unless overwritten during the send.
DialPrefixstringreserved
PageOrientationreserved

PageOrientation

ValuesDescription
landscapeAll pages are landscape in document.
portraitAll pages are portrait in document.
PaperSizereserved

PaperSize

ValuesDescription
LetterAll pages are letter size in document.
LegalAll pages are Legal size in document.
A4All pages are A4 size in document.
B4All pages are B4 size in document.
CountryCodestringreserved
ProxyUserreserved

Boolean

ValuesDescription
trueTrue
falseFalse.
AllowAdminApireserved

Boolean

ValuesDescription
trueTrue
falseFalse.
CoverPageNamestringMust be a valid cover page name template name. Use EnumerateCoverPages to list available cover page templates.
CpTitlestringJob title. (optionally used in Cover page).
CpCompanyNamestringCompany Name (optionally used in Cover page).
CpAddress1stringAddress Line (optionally used in Cover page).
CpAddress2stringAddress Line (optionally used in Cover page).
CpVoiceNumberstringPhone Number (optionally used in Cover page).
CpEmailstringEmail address. (optionally used in Cover page).
TSIstring

TSI and CSI

TSI (Transmitting Station Identifier) is a string that a sending fax machine sends to the receiving fax machine. The receiving fax machine usually displays this value on the fax machines LCD display.

CSI (Called Station Identifier) is a string that a receiving fax machine sends to the sending fax machine. The sending fax machine usually displays this string on the fax machines LCD display.

TSI and CSI are transmitted during initial stage of the fax protocol negotiation

Prioritystringreserved
RetryCountstringNumber of times to attempt to send the fax.
RetryIntervalstringNumber of minutes between attempts to send the fax.
DeleteAfterSendIf "true"then the fax is deleted after it is successfully sent.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
EmailAddressstringEmail address used for fax notifications when receiving a fax.
ReceiveFaxNotifySet to "true"if you want recipient to receive an email when a fax is received.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxNotifyAttachSet to "true" if you want the fax to be attached in the email notification.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedAttachUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PrinterNamestringreserved
SendPreFilterstringreserved
SendPostFilterstringreserved
ReceiveFaxFilterstringreserved
SentPagesreserved

Int

TypeDescription
stringA positive or negative integer.
SentPagesThresholdreserved

Int

TypeDescription
stringA positive or negative integer.
ReceivedPagesreserved

Int

TypeDescription
stringA positive or negative integer.
ReceivedPagesThresholdreserved

Int

TypeDescription
stringA positive or negative integer.
CoverPageNameDefaultstring
ReservedWCstringreserved
FaxHeaderstring containing Indicates content of fax header. Will only be used is FaxHeaderEnabled is set to true. The Fax Header can contains static text and keywords that are replaced with real data. The default fax header format is date/time + TSI + pages.

Fax Header Keywords

Keywords are case sensitive.

ValuesDescription
%t% character
%tTime
%dDate
%PPage number
%pTotal pages
%iSender TSI
%jSender name
%kSender DID (fax number)
%lSender telephone number
%mSender email
%nSend job id
%aRecipient name
%bRecipient company name
%cRecipient title
%eRecipient fax number
%fRecipient telephone number
%CNCover page field with field id N, N is a number, eg %C333 to insert cover page 333
FaxHeaderEnabled Used to indicate if the fax header should be included in the fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ScanBarcodeCheck for barcodes in inbound faxes. Barcode service must be enabled in order for this to work.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
M2fIgnoreSubjectIgnore the subject of the email message when sending email to fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
M2fIgnoreBodyIgnore the body of the email message when sending email to fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ParentUserIdstringignored
SendEnabledAllow user to be able to send a fax.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifySmAccessReceive email notification if a send secure document message was accessed by the recipient.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
AllowSmApiAllow user to perform secure document message features such as sending a message.

Boolean

ValuesDescription
trueTrue
falseFalse.
SendFaxNotifySuccessAttachAttach fax after a successful send.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SmRecipientRefstringEmail of recipient that user is liked to. This field is read only.
SmRecipientRefIsValidIndicates if the recipient link is valid. If the recipient changes their password then the link will become invalid. This field is read only.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyUrlstringURL to post HTTP information about incoming and outgoing faxes.
NotifyUrlSendIndicates whether to sent HTTP posts to the NotifyURL for outbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUrlRecvIndicates whether to sent HTTP posts to the NotifyURL for inbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.

ModifyUserOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.

DeleteUser

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

DeleteUserInput

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.

DeleteUserOutput

NameTypeDescription
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.


QueryUser

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

QueryUserInput

NameTypeDescription
AuthenticationUser credentials.

Authentication

NameTypeDescription
LoginstringSoftlinx Cloud Fax Username or Secure Document recipient email address.
PasswordstringPassword for user
PasswordSecurity"none" - Indicates if the password is in plain text or "base64" Indicates that the password is encoded using base-64

PasswordSecurity

ValuesDescription
nonePassword is not encoded.
base64Password is base64 encoded.
RealmstringThe unique identifier for an organization. All user credentials are validated in the content of the realm. As part of the customer onboarding process, a realm id will be provided. On-premise customers leave this empty. If user is Secure Document recipient, then leave empty.
AuthenticationTokenToken for previously authenticated credentials.

AuthenticationToken

NameTypeDescription
AuthTokenstringA string that contain the token. This string is obtained by issuing a Login request.
UserIdstringReplix User ID.
ResultLimitMaximum number of users to return.

PositiveInt

TypeDescription
stringAn integer greater than 0.
NextResultIf "true", then only users where UserID is greater than the UserID specified will be returned.

Boolean

ValuesDescription
trueTrue
falseFalse.
GetDefaultValuesIf set to true, then the default cover page for the user is calculated.

Boolean

ValuesDescription
trueTrue
falseFalse.

QueryUserOutput

NameTypeDescription
UserInfoList of USers that meet search criteria.

UserInfo

NameTypeDescription
UserIdstringUnique ID for a Softlinx Cloud Fax user. Used to log into portal.
NamestringUser's Name
NativeUserIdstringreserved
PasswordstringUser's password.
FaxNumberstringDID number. When faxes are received at this number, they will get routed to this user.
DepartmentIdstringOnly set if a user is a member of a department. Use QueryDepartment to obtain valid department IDs.
ProjectCodestringApplication specific string. This is the account number associated with the user. Any faxes sent out by this user will have this accout unless overwritten during the send.
ProjectCode2stringApplication specific string. This is the default keywords associated with the user. Any faxes sent out by this user will have these keywords unless overwritten during the send.
DialPrefixstringreserved
PageOrientationreserved

PageOrientation

ValuesDescription
landscapeAll pages are landscape in document.
portraitAll pages are portrait in document.
PaperSizereserved

PaperSize

ValuesDescription
LetterAll pages are letter size in document.
LegalAll pages are Legal size in document.
A4All pages are A4 size in document.
B4All pages are B4 size in document.
CountryCodestringreserved
ProxyUserreserved

Boolean

ValuesDescription
trueTrue
falseFalse.
AllowAdminApireserved

Boolean

ValuesDescription
trueTrue
falseFalse.
CoverPageNamestringMust be a valid cover page name template name. Use EnumerateCoverPages to list available cover page templates.
CpTitlestringJob title. (optionally used in Cover page).
CpCompanyNamestringCompany Name (optionally used in Cover page).
CpAddress1stringAddress Line (optionally used in Cover page).
CpAddress2stringAddress Line (optionally used in Cover page).
CpVoiceNumberstringPhone Number (optionally used in Cover page).
CpEmailstringEmail address. (optionally used in Cover page).
TSIstring

TSI and CSI

TSI (Transmitting Station Identifier) is a string that a sending fax machine sends to the receiving fax machine. The receiving fax machine usually displays this value on the fax machines LCD display.

CSI (Called Station Identifier) is a string that a receiving fax machine sends to the sending fax machine. The sending fax machine usually displays this string on the fax machines LCD display.

TSI and CSI are transmitted during initial stage of the fax protocol negotiation

Prioritystringreserved
RetryCountstringNumber of times to attempt to send the fax.
RetryIntervalstringNumber of minutes between attempts to send the fax.
DeleteAfterSendIf "true"then the fax is deleted after it is successfully sent.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
EmailAddressstringEmail address used for fax notifications when receiving a fax.
ReceiveFaxNotifySet to "true"if you want recipient to receive an email when a fax is received.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxNotifyAttachSet to "true" if you want the fax to be attached in the email notification.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxNotifyFailedAttachUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ReceiveFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SendFaxPrintreserved

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
PrinterNamestringreserved
SendPreFilterstringreserved
SendPostFilterstringreserved
ReceiveFaxFilterstringreserved
SentPagesreserved

Int

TypeDescription
stringA positive or negative integer.
SentPagesThresholdreserved

Int

TypeDescription
stringA positive or negative integer.
ReceivedPagesreserved

Int

TypeDescription
stringA positive or negative integer.
ReceivedPagesThresholdreserved

Int

TypeDescription
stringA positive or negative integer.
CoverPageNameDefaultstring
ReservedWCstringreserved
FaxHeaderstring containing Indicates content of fax header. Will only be used is FaxHeaderEnabled is set to true. The Fax Header can contains static text and keywords that are replaced with real data. The default fax header format is date/time + TSI + pages.

Fax Header Keywords

Keywords are case sensitive.

ValuesDescription
%t% character
%tTime
%dDate
%PPage number
%pTotal pages
%iSender TSI
%jSender name
%kSender DID (fax number)
%lSender telephone number
%mSender email
%nSend job id
%aRecipient name
%bRecipient company name
%cRecipient title
%eRecipient fax number
%fRecipient telephone number
%CNCover page field with field id N, N is a number, eg %C333 to insert cover page 333
FaxHeaderEnabled Used to indicate if the fax header should be included in the fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ScanBarcodeCheck for barcodes in inbound faxes. Barcode service must be enabled in order for this to work.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
M2fIgnoreSubjectIgnore the subject of the email message when sending email to fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
M2fIgnoreBodyIgnore the body of the email message when sending email to fax.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
ParentUserIdstringignored
SendEnabledAllow user to be able to send a fax.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifySmAccessReceive email notification if a send secure document message was accessed by the recipient.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
AllowSmApiAllow user to perform secure document message features such as sending a message.

Boolean

ValuesDescription
trueTrue
falseFalse.
SendFaxNotifySuccessAttachAttach fax after a successful send.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
SmRecipientRefstringEmail of recipient that user is liked to. This field is read only.
SmRecipientRefIsValidIndicates if the recipient link is valid. If the recipient changes their password then the link will become invalid. This field is read only.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyUrlstringURL to post HTTP information about incoming and outgoing faxes.
NotifyUrlSendIndicates whether to sent HTTP posts to the NotifyURL for outbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
NotifyUrlRecvIndicates whether to sent HTTP posts to the NotifyURL for inbound faxes. Before setting this URL, discuss with Softlinx support.

Boolean3

ValuesDescription
trueTrue
falseFalse.
defaultUse default value of parent object.
HasMoreResultsWill be "true" if ResultLimit was set to "true" and not all of the remaining users were returned.

Boolean

ValuesDescription
trueTrue
falseFalse.
RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.

RequestStatus

NameTypeDescription
StatusCodeError number.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
StatusTextstringDescription of error.


LinkSmRecipient

The LinkSmRecipient method is a SOAP request for linking a Replix user to a Secure Document Recipient. Once a user is linked, they will be able to access received secure document messages.

LinkSmRecipientInput

NameTypeDescription
AuthenticationUser credentials.
AuthenticationTokenToken for previously authenticated credentials.
FaxUserIdstringReplix User ID.
SmUserEmailstringRecipient email address.
SmUserPasswordstringRecipient's password.

LinkSmRecipientOutput

RequestStatusCheck for StatusCode = "0" to verify that request executed correctly.