Summary

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


WSDL

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

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

XML Schema Element Types

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

Messages with Attachments

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

Fax Identifiers

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

API Input/Output

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

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

Arguments

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

RequestStatus

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

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

Request Credentials

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

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

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 machine’s 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 machine’s LCD display.

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

SOAP request response names

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

API version

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


Authentication Overview

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

Using the Authentication Element

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

Using the AuthenticationToken Element

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


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 Faxes Overview

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


SendFax

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

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

Output:

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

SendFaxInput


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.
RetryCountNumber of times to attempt to send the fax. This includes the initial attempt and any retries. It is recommended that the RetryCount be set between 3 and 5. The cloud service will enforce a minimal and maximum value to ensure optimal performance.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
RetryIntervalNumber of minutes between attempts to send the fax. It is recommended that the Retry Interval be set between 10 and 20 minutes. The cloud service will enforce a minimum and maximum value to ensure optimal performance.

PositiveInt

TypeDescription
stringAn integer greater than 0.
SendAfterDate/time after which to attempt to send the fax. If missing, attempts to send as soon as possible.

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
FaxQualityreserved

FaxQuality

ValuesDescription
low204x98 resolution
high204x196 resolution
FaxRecipientlist of sInformation about the recipient of the fax, including fax number.

FaxRecipient

NameTypeDescription
FaxNumberstringDestination fax number field (required), e.g., 17915551212. Note: a "1" is required for US and Canadian numbers. A "+" should proceed international numbers.
RcptNamestringRecipient name field (used in Cover page template).
RcptCompanystringCompany name field (used in Cover page template).
RcptTitlestringTitle field (used in Cover page template).
RcptFaxstringFax number field (used in Cover page template).
RcptVoicestringVoice number field (used in Cover page template).
Attachmentlist of sFiles to send.

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.
CoverPageEnabledUsed to indicate whether a cover page is used. If you set the CoverPageName to a value, then you need to set this to true. If you set this to "true" and do not set a CoverPageName, then the default cover page will be used.

Boolean

ValuesDescription
trueTrue
falseFalse.
CoverPageNamestringCover page name that is stored in the fax server cover page directory. A Softlinx customer service representative can assist in creating custom cover pages.
CoverMessagestringCover page message goes into "message" field on the cover page.
CoverFieldlist of sA cover field should contain a unique field id and the value associated with this id. If the cover page contains a field with the same ID, then the value will but put into the cover page when the fax is generated.

CoverField

NameTypeDescription
FieldId stringCode number should be above 305. Should match field number in cover page.
ValuestringText to put into PDF field.

PositiveInt

TypeDescription
stringAn integer greater than 0.
CoverFieldCCstringCover page CC field.
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
FaxHeaderEnabledUsed to indicate if the fax header should be included in the fax.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyEmailAddressstringEmail address to send fax notifications.
NotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifySuccessAttachFaxUsed to enable/disable fax image attachment in the email notification after send success. The image won't contain the fax header.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyFailedAttachFaxUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean

ValuesDescription
trueTrue
falseFalse.
DeleteAfterSendUsed to delete/keep fax files on disk after successful send. After send failure faxes are always kept.

Boolean

ValuesDescription
trueTrue
falseFalse.
FaxDescriptionstringThe fax description does not become part of the fax image, but becomes part of fax meta data and is returned from QuerySendFax API.
PriorityFax sending priority (0 to 10). This value is ignored by the cloud service. All faxes have the same priority.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
ProjectCodestringApplication specific string, aka reference keyword.
ProjectCode2stringApplication specific string. If set, this will overwrite the account number associated with the user.
ProjectCode3stringApplication specific string.
ProjectCode4stringApplication specific string.
ProjectCode5stringApplication specific string.
TSIstringTransmitting station identifier is the string that the receiving fax device displays on the device LCD. The maximum number of characters for this string is 20. Any value more than 20 characters will be truncated when the fax is sent. The TSI string can be part of the fax header.
FaxUserIdstringSpecifies the owner of the fax. Normally the fax owner is determined from the HTTP request authentication, but your current credentials may allow (if configured so by the fax administrator) to specify a different owner. E.g, your login credentials are "bob" but your application may decide to assign the ownership to "mary" (so "bob" proxies sends fax for "mary").
Text2tiffFontNamestringFont name when converting text to tiff image. Backend specific, is very unlikely you will ever need to use this.
PageOrientationUse "landscape" or "portrait" to specify 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.
PageSizestringReserved. Do not specify.
CoverMessageCharsPerLineReserved

PositiveInt

TypeDescription
stringAn integer greater than 0.
BatchNamestringUsed by the Batch Loader.
BatchUniqueIdstringUsed by the Batch Loader.
RequestOriginstringAn identifier that can be used to determine which custom application was used to generate the fax.
NotifyUrlstringURL to receive HTTP posts regarding the status of this fax. Before setting this URL, discuss with Softlinx support.

SendFaxOutput

NameTypeDescription
FaxInfoList of Information about the Fax job(s) created.

NewSendFaxInfo

NameTypeDescription
FaxIdstringOutgoing fax identifier.
FaxNumberstringOutgoing fax number.
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.

ResendFax

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501C0FA.624ACBB <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:ResendFaxResponse> <ResendFaxOutput> <FaxInfo> <FaxId>
fax id
</FaxId> <FaxNumber>
fax number
</FaxNumber> </FaxInfo> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </ResendFaxOutput> </rpx:ResendFaxResponse> </soap:Body> </soap:Envelope>

ResendFaxInput

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.
FaxNumberstringNew destination fax number. Ex: 15556780912
FaxIdOriginal Fax ID.

PositiveInt

TypeDescription
stringAn integer greater than 0.

ResendFaxOutput

NameTypeDescription
FaxInfoInformation about the Fax job created.

NewSendFaxInfo

NameTypeDescription
FaxIdstringOutgoing fax identifier.
FaxNumberstringOutgoing fax number.
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.

QuerySendFax

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

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

Output:

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

QuerySendFaxInput

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

PositiveInt

TypeDescription
stringAn integer greater than 0.
DatetimeAfterDate/time that limits the results to faxes that have been updated (or completed when fax has a final status of sent or sendFailed) at specified or later date/time.

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
DatetimeBeforeDate/time that limits the results to faxes that have been updated (or completed when fax has a final status of sent or sendFailed) at specified or earlier date/time.

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
DepartmentNamestringLimit faxes returned to those owned by fax users in a specific department.
FaxUserIdstringLimit faxes returned to those owned by specific fax user id. If the user has the appropriate privileges, set this to "*" to see all users. If the username set in the credentials does not have the proxy user privilege, this parameter will be ignored.
FaxStatusQuery for specific fax status.

SendFaxStatus

ValuesDescription
sentSent Faxes.
sendFailedFaxes that cannot be sent.
awaitingConversionFaxes waiting to be converted to TIFF Fax format.
awaitingCoverpageFaxes waiting for a cover page template.
scheduledFaxes waiting to be sent.
sendingFaxes in the process of being sent.
Mark"true" or "false". Do not set to return both marked and unmarked faxes.

Boolean

ValuesDescription
trueTrue
falseFalse.
BatchNamestringUsed by the Batch Loader.
BatchUniqueIdstringUsed by the Batch Loader.
SortColumnSpecify which column to sort on. Only certain columns are supported.

QuerySendFaxSortColumn

ValuesDescription
faxIdFax Identifier
dateTimeLast modified time
SortOrderSort how results are returned.

QuerySortOrder

ValuesDescription
ascSort ascending.
descSort descending.
ResultLimitLimit number of fax records to specific amount.

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 faxes, 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 faxes, except for the number of faxes to return.

Response

NameTypeDescription
FaxInfoList of Information about the Fax job(s) created.

SendFaxInfo

NameTypeDescription
FaxIDUnique fax identifier.

PositiveInt

TypeDescription
stringAn integer greater than 0.
GroupId Fax group identifier. If a fax request is made with multiple recipients, then a unique fax request is generated for each recipient. The group identifier for all of these faxes will be the same. It will be the fax id of the first fax in the group.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
FaxUserIdstringID of the user that sent the fax.
FaxNumberstringOutgoing fax number.
FaxStatusStatus of fax.

SendFaxStatus

ValuesDescription
sentSent Faxes.
sendFailedFaxes that cannot be sent.
awaitingConversionFaxes waiting to be converted to TIFF Fax format.
awaitingCoverpageFaxes waiting for a cover page template.
scheduledFaxes waiting to be sent.
sendingFaxes in the process of being sent.
CompleteTimestringDate/time fax was completed (fax is completed when it reaches status of "sent" or "sendFailed") or last updated (fax status is other than final).
CreateTimestringDate/time fax was created.
SendAfterstringDate/time value of "SendAfter" SendFax request API input argument.
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

CSIstring

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

DurationFax duration in seconds.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
ErrorCodeNumeric error code of the error encountered by the fax server backend.

SendErrors

Error CodeError Text (may vary with same error code)Cause
0Cannot retrieve record … No record foundSystem issue.
 Cannot open fax file.System issue.
 Unable to retrieve user info.System issue.
 Cannot combine fax files.System issue.
 Invalid phone number. Missing digits.System issue.
1000Call rejectedPotentially recipient rejected call.
 Temporary failureTelco network unavailable.
 Cannot open fax file.System issue.
 Answer - Marked by SilencePotentially is not a fax number.
 Retrieve fax file failedSystem issue.
 Dial TonePotentially is not a fax number.
 RMTOFFHOOKTelco issue.
 Recovery on timer expirationTelco issue.
 Network read: Network read. 10054:Connection reset.System issue.
 Unallocated numberTelco issue.
 Network out of orderTelco issue.
 Dial: Call collision detected.Telco issue.
 Service not implemented; unspecifiedTelco issue.
 Interrupted. Server shutdownSystem issue.
 Coverpage and fax merge failed.System issue.
 Invalid phone number. Missing digits.Invalid fax number.
 Cannot retrieve fax files.System issue.
 Custom IMG not member of configured IMGsSystem issue.
 Invalid number formatInvalid fax number.
 Transmission errorTelco issue.
1002BusyBusy
1003Circuits BusyTemporary problem establishing a call.
1004No answerRing, but no answer.
1005No fax tonePotentially is not a fax number.
1009sit intercept toneTelco network busy.
 sit vacant toneTelco issue.
 sit no circuit toneTelco issue.
 sit reorder toneTelco issue.
1041Fax number rejected by fax server fax number restriction …Intentionally blocked fax number.
1100Call answered. Possibly by a personPotentially is not a fax number.
1101Dial - no answer from central officePotentially is not a fax number.
1102Dial - call disconnectedProblem establishing a call.
1103fax processing excessive durationFax file may be too large.
3002FaxBegin/FaxEndDoc/FaxRemoteInfo/FaxSendPage/FaxTraining … Page ? rejected by recipient. ConfVal …Fax transmission issue.
3002FaxBegin/FaxEndDoc/FaxRemoteInfo/FaxSendPage/FaxTraining … Fax transmission issue.
 Page ? rejected by recipient. ConfVal …Fax transmission issue.
 TiffNextPage …Fax transmission issue.
4001Error converting document to FAX.Fax input file invalid.
ErrorTextstringText string corresponding to ErrorCode, empty for no error.
PagesTotalNumber of all fax pages in the outgoing fax.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
PagesSentNumber of pages sent.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
FaxQuality reserved

FaxQuality

ValuesDescription
low204x98 resolution
high204x196 resolution
RetryCountNumber of times to attempt to send the fax.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
RetryCountLeftNumber of times to attempt to send the fax.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
RetryIntervalNumber of minutes between attempts to send the fax.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
CoverPageNamestringCover page template name used in this fax.
RcptInfostringValues from SendFax FaxRecipient argument, separated by ":".
Priority reserved
FaxDescriptionstring Value specified when making a SendFax call.
DeleteAfterSendIf "true" then the fax is deleted after it is successfully sent.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyEmailAddressstringNotification email address.
NotifySuccessUsed to enable/disable email notification after fax was sent successfully.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyFailedUsed to enable/disable email notification after a fax send failed.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyFailedAttachFaxUsed to enable/disable fax image attachment in the email notification after send failure.

Boolean

ValuesDescription
trueTrue
falseFalse.
FaxHeaderEnabledTrue if fax includes a fax header.

Boolean

ValuesDescription
trueTrue
falseFalse.
PrintAfterSendreserved

Boolean

ValuesDescription
trueTrue
falseFalse.
ProjectCodestringApplication specific string. This is the account number associated with the fax.
ProjectCode2stringApplication specific string. This is the keywords associated with the fax.
ProjectCode3stringApplication specific string.
ProjectCode4stringApplication specific string.
ProjectCode5stringApplication specific string.
ImgHoststringIMG host or IP that received this fax.
ImgDevicestringIMG fax device.
ImgCountrystringreserved
Reserved2stringreserved
ProxyFaxUserIdstring Fax user id which created this fax.
MarkTags the fax to allow searching for un-tagged faxes.

Boolean

ValuesDescription
trueTrue
falseFalse.
BatchNamestring Set by Batch Loader.
BatchUniqueIdstringSet by Batch Loader.
ReservedDM1"true" if delivery manager has retrieved this fax.

Boolean

ValuesDescription
trueTrue
falseFalse.
ReservedDM2stringInformation about the machine running the Delivery Manager.
FaxHeaderstring containing Header text.

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

GetSendFaxContent

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5501C89A.215C23E6 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:GetSendFaxContentResponse> <GetSendFaxContentOutput> <FaxContent> <ContentType>application/pdf</ContentType> <FileName>x.pdf</FileName> <ImageContent>[binary data]</ImageContent> </FaxContent> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </GetSendFaxContentOutput> </rpx:GetSendFaxContentResponse> </soap:Body> </soap:Envelope>

GetSendFaxContentInput

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

PositiveInt

TypeDescription
stringAn integer greater than 0.
FaxContentTypeFax document format. If not specified, document will be returned in TIFF format.

FaxContentType

ValuesDescription
tifTiff format
pdfPDF format
FaxContentSelectorIdentifies the part of the fax to return. Default is entire fax.

SendFaxContentSelector

ValuesDescription
allReturn entire fax content.
coverPageReturn just the cover page. Only applicable if a ReplixFax cover page template was used.
bodyReturn all pages excluding the cover page. Only applicable if a ReplixFax cover page template was used.
MtomXopIf set to true, then fax content will be returned as part of multipart/related message. If set to false, then fax content will be returned inside the SOAP message. Default is true.

Boolean

ValuesDescription
trueTrue
falseFalse.

GetSendFaxContentOutput

NameTypeDescription
FaxContentInformation about the Fax job(s) created.

FaxContent

NameTypeDescription
ContentTypestring"image/tiff" or "application/pdf".
FileNamestringInternal name of file stored by the ReplixFax server.
ImageContentbase64BinaryBinary content of fax file.
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.

DeleteSendFax

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

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

Output:


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

DeleteSendFaxInput

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.
FaxIdList of Fax identifier(s).

PositiveInt

TypeDescription
stringAn integer greater than 0.

DeleteSendFaxOutput

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.

ModifySendFax

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

Input:


Connection: keep-alive
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 Accept: text/xml, multipart/related Authorization: BASIC UUEtMTBcUmVwbGl4OlJlcGxpeA== Host: qa-10 User-Agent: JAX-WS RI 2.2.4-b01 SOAPAction: "http://www.softlinx.com/wsapi/op=ModifySendFax/ver=19" <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:ModifySendFax xmlns:ns2="http://www.softlinx.com/ReplixFax"> <ModifySendFaxInput> <Authentication> <Login>
username
</Login> <Password>
password
d</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <FaxId>
fax id
</FaxId> <Mark>true</Mark> </ModifySendFaxInput> </ns2:ModifySendFax> </S:Body> </S:Envelope>

Output:

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

ModifySendFaxInput

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

PositiveInt

TypeDescription
stringAn integer greater than 0.
MarkIndicate whether or not to mark the fax.

Boolean

ValuesDescription
trueTrue
falseFalse.

ModifySendFaxOutput

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.

Inbound Faxes Overview

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


QueryReceiveFax

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

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C849.37C24AB1 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:QueryReceiveFaxResponse> <QueryReceiveFaxOutput> <FaxInfo> <FaxId>x</FaxId> <FaxUserId>x</FaxUserId> <FaxStatus>recvOk</FaxStatus> <TSI>x.</TSI> <CSI/> <ReceivedTime>2015-02-20T18:42:58Z</ReceivedTime> <CreateTime>2015-02-20T18:42:58Z</CreateTime> <PagesReceived>1</PagesReceived> <DestFaxNumber>x</DestFaxNumber> <CallerNumber/> <Duration>0</Duration> <ErrorCode>0</ErrorCode> <ErrorText/> <NotifyEmail>true</NotifyEmail> <NotifyAttachFax>true</NotifyAttachFax> <PrintFax>false</PrintFax> <Viewed>true</Viewed> <ImgHost>x</ImgHost> <ImgDevice>network</ImgDevice> <Caption/> <Note/> <ImgCountry/> <Mark>true</Mark> <ProjectCode>xxx</ProjectCode> <ProjectCode2/> </FaxInfo> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </QueryReceiveFaxOutput> </rpx:QueryReceiveFaxResponse> </soap:Body> </soap:Envelope>

QueryReceiveFaxInput

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

PositiveInt

TypeDescription
stringAn integer greater than 0.
DatetimeAfterDate/time that limits the results to faxes that have been received at specified or later date/time.

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
DatetimeBeforeDate/time that limits the results to faxes that have been received at specified or earlier date/time.

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
DepartmentNamestringLimit faxes returned to those owned by fax users in a specific department.
FaxUserIdstringLimit faxes retrieved to those owned by specific fax user id. Unless your current login is configured as a proxy user, you should leave this field empty as the fax server will only return faxes owned by your current login. If you are an administrator, set to "*" to see all users faxes.
Mark"true" or "false". Do not set to return both marked and unmarked faxes.

Boolean

ValuesDescription
trueTrue
falseFalse.
FaxStatusQuery for specific fax status.

ReceiveFaxStatus

ValuesDescription
recvOkFax received.
recvIncompleteError during receive.
ResultLimitLimit number of fax records to specific amount.

PositiveInt

TypeDescription
stringAn integer greater than 0.
GetNextResultsIf 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 faxes, 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 faxes, except for the number of faxes to return.

Boolean

ValuesDescription
trueTrue
falseFalse.
SortColumnColumn to use for sorting during the query.

QueryReceiveFaxSortColumn

ValuesDescription
faxIdFax ID.
dateTimeLast modified time.
SortOrderSort order of query.

QuerySortOrder

ValuesDescription
ascSort ascending.
descSort descending.

QueryReceiveFaxOutput

NameTypeDescription
FaxInfoList of Information about the Fax job(s) created.

ReceiveFaxInfo

NameTypeDescription
FaxIDPositiveIntUnique fax identifier.
FaxUserIdstringID of the user that received the fax.
FaxStatusReceiveFaxStatusStatus of fax.
TSIstringTransmitting Station Identifier
CSIstringCalled Station Identifier
ReceivedTimestringDate/time fax was received.
CreateTimestringDate/time fax was created.
PagesReceivedNumber of pages received.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
DestFaxNumberstringDestination fax number represents the number that was dialed by the sender or a fax number associated with the fax line.
CallerNumberstringCalling party number, if available.
DurationFax duration in seconds.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
ErrorCodeNumeric status of the error encountered, 0 – for no error, specific to the fax server backend.

NonNegativeInt

TypeDescription
stringAn integer greater than or equal to 0.
ErrorTextstringText string corresponding to ErrorCode, empty for no error.
NotifyEmailTrue if email notification was sent when fax was received.

Boolean

ValuesDescription
trueTrue
falseFalse.
NotifyAttachFaxTrue if fax was attached to the email notification.

Boolean

ValuesDescription
trueTrue
falseFalse.
PrintFaxTrue if fax was printing after it was received.

Boolean

ValuesDescription
trueTrue
falseFalse.
ViewedTrue if fax is marked as viewed.

Boolean

ValuesDescription
trueTrue
falseFalse.
ImgHoststringIMG host or IP that received this fax.
ImgDevicestringIMG fax device.
CaptionstringIf fax was routed from another user, then this is the message from that user.
NotestringIndicates which user routed fax.
ImgCountrystringreserved
MarkAfter retrieving the fax, you can mark it so it does nto appear in subsequent queries.

Boolean

ValuesDescription
trueTrue
falseFalse.
ProjectCodestringApplication specific string.
ProjectCode2stringApplication specific string, aka reference keyword.
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.
ResultsReferencestringA key that is set if there are more faxes 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 faxes.

GetReceiveFaxContent

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C90E.958FF19 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:GetReceiveFaxContentResponse> <GetReceiveFaxContentOutput> <FaxContent> <ContentType>application/pdf</ContentType> <FileName>x.pdf</FileName> <ImageContent>[binary data]</ImageContent> </FaxContent> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </GetReceiveFaxContentOutput> </rpx:GetReceiveFaxContentResponse> </soap:Body> </soap:Envelope>

GetReceiveFaxContentInput

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

PositiveInt

TypeDescription
stringAn integer greater than 0.
FaxContentTypeFax document format. If not specified, document will be returned in TIFF format.

FaxContentType

ValuesDescription
tifTiff format
pdfPDF format

GetReceiveFaxContentOutput

NameTypeDescription
FaxContentInformation about the Fax job(s) created.

FaxContent

NameTypeDescription
ContentTypestring"image/tiff" or "application/pdf".
FileNamestringInternal name of file stored by the ReplixFax server.
ImageContentbase64BinaryBinary content of fax file.
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.

DeleteReceiveFax

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C9C6.3CC8C9E9 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:DeleteReceiveFaxResponse> <DeleteReceiveFaxOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </DeleteReceiveFaxOutput> </rpx:DeleteReceiveFaxResponse> </soap:Body> </soap:Envelope>

DeleteReceiveFaxInput

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.
FaxIdList of Fax identifier(s).

PositiveInt

TypeDescription
stringAn integer greater than 0.

DeleteReceiveFaxOutput

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.

ModifyReceiveFax

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502C970.3070AD64 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:ModifyReceiveFaxResponse> <ModifyReceiveFaxOutput> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </ModifyReceiveFaxOutput> </rpx:ModifyReceiveFaxResponse> </soap:Body> </soap:Envelope>

ModifyReceiveFaxInput

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.
FaxIdFax identifier(s).

PositiveInt

TypeDescription
stringAn integer greater than 0.
MarkIndicate whether or not to mark the fax.

Boolean

ValuesDescription
trueTrue
falseFalse.
ProjectCodestringApplication specific string. Account number associated with fax.
ProjectCode2stringApplication specific string. Keyword associated with fax.

ModifyReceiveFaxOutput

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.

Cover Page Overview

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

Cover Page Templates

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

Cover Page Metadata Fields

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

DescriptionHow to Set Value
Sender's nameTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Recipient's nameFaxRecipient.RcptName
Recipient's company nameFaxRecipient.RcptCompany
Recipient's titleFaxRecipient.RcptTitle
Recipient's fax numberFaxRecipient.RcptFax
Recipient's voice numberFaxRecipient.RcptVoice
Carbon CopySendFaxInput.CoverFieldCC
Cover page messageSendFaxInput.CoverMessage
Total Pages
Date of fax transmission
Sender's voice numberTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's DID numberTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's department nameTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's company nameTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's address linesTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's job titleTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Sender's email addressTaken from the user that was specified for the WSAPI authentication. If SendFaxInput.FaxUserId is specified, then this user’s attributes are used.
Project Codes Five values specified when sending a fax. Two can have default values associated with the user or the user’s department.

Standard Cover Pages


EnumerateCoverPages

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

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

Output:

HTTP/1.0 200 OK
Content-Length: 
length
Content-Type: text/xml; charset=utf-8 X-replixfax-diag-id: 5eacef4a0ab3e84d8c18b0942b11cd59.5502D235.14526F48 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:EnumerateCoverPagesResponse> <EnumerateCoverPagesOutput> <CoverPage>cover</CoverPage> <CoverPage>facsimile</CoverPage> <CoverPage>memo</CoverPage> <CoverPage>urgent</CoverPage> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </EnumerateCoverPagesOutput> </rpx:EnumerateCoverPagesResponse> </soap:Body> </soap:Envelope>

EnumerateCoverPagesInput

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.
FaxUserIdstringFax user id. There are global cover pages available to all users but some cover pages are user specific. This is optional.

EnumerateCoverPagesOutput

NameTypeDescription
CoverPagestringsName of the cover page(s).
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.

Barcode Overview

Softlinx provides the ability to generate barcode images for faxes. The barcode images can be provided to fax senders. If these barcode images are present on the first or second page of an incoming fax, their values can be read and be available as part of the fax metadata.


CreateBarcode

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

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=CreateBarcode/ver=23" <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:CreateBarcode xmlns:ns2="http://www.softlinx.com/ReplixFax"> <CreateBarcodeInput> <Authentication> <Login>
username
</Login> <Password>
password
d</Password> <PasswordSecurity>base64</PasswordSecurity> <Realm>
organization
</Realm> </Authentication> <BarcodeData>1234</BarcodeData> <BarcodeType>Pdf417<BarcodeType> <OutputFormat>png<OutputFormat> </CreateBarcodeInput> </ns2:CreateBarcode> </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.5502D235.14526F48 <soap:Envelope xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rpx="http://www.softlinx.com/ReplixFax"> <soap:Body> <rpx:CreateBarcodeResponse> <CreateBarcodeOutput> <Barcode> <ContentType>image/png</ContentType> <FileName>barcode.ad875c608dfab641.png</FileName> <AttachmentContent>barcode image bytes</AttachmentContent> </Barcode> <RequestStatus> <StatusCode>0</StatusCode> <StatusText/> </RequestStatus> </CreateBarcodeOutput> </rpx:CreateBarcodeResponse> </soap:Body> </soap:Envelope>

CreateBarcodeInput

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.
BarcodeDatastringThe value to be translated to a barcode image.
BarcodeTypestringThis value should be set to Pdf417.
OutputFormatstringSupported output formats are: pdf, png, tif, bmp, and gif.
BarcodeDpistringThis value is ignored.
BarcodeXModulestringThis value is ignored.
MtomXopIf set to true, then the barcode image will be returned as part of multipart/related message. If set to false, then the barcode image will be returned inside the SOAP message. Default is true.

Boolean

ValuesDescription
trueTrue
falseFalse.
OutputRotationThis value is ignored.

PositiveInt

TypeDescription
stringAn integer greater than 0.

CreateBarcodeOutput

NameTypeDescription
BarcodeBarcode image.

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