General Overview

This document provides an overview and method details for the FaxAgent Extended Services.

The extended services allow integration with a providioning system for general user administration tasks and provide user options to process fax requests from remote locations.

All Non-Direct Stream Methods return their result data wrapped in a common Response XML envelope. This gives the invoking application an additional consistent way to interpret success or failure and retrieve the result data from the method, as well as detailed error information.

Please Note: All timestamps returned within XML response attributes are in UTC format.

Service Invocation Overview

All Service Methods are invoked using an HTTP request.

Service Method Invocation Example

https://fax.example.com/xws/?XM=FaxAdmin.ApiTest&XSC=ABC&XSK=123

fax.example.com FaxAgent Server DNS Name
XM Parameter Service Method to Invoke
XSC Parameter Security Context; Code of Tenant Enacting API Service
XSK Parameter Security Key; Set by User in Admin > Permissions > API

Service Output Headers

When invoking Service Methods, some Methods return XML wrapped results, and some methods utilize Direct Streaming of the result data directly to the Response Stream. Success or Failure is determined for each as follows:

For all methods, success is determined by inspecting the Response Header: XwsSuccess. This allows high-volume service calls to be very efficient when the consumer does not care about inspecting the detailed Response Data payload in the case of success.

The following Response Headers are set for all Method invocations.

Header Type Values Sample Description
XwsServiceName String XFax Service Class Name
XwsServiceMethod String FaxAdmin.ApiTest Signature of Service Method
XwsRequestId String 6532827CC32B4DEE9C0FF1C5C8B1AFDD Unique request id for transaction
XwsRequestDate Date 2022-04-29T00:03:24Z UTC Timestamp when the Request was received
XwsResponseDate Date 2022-04-29T00:03:24Z UTC Timestamp when the Response was completed
XwsSuccess Bool 0,1 1 "1" indicates successful. "0" indicates failure
XwsAbort Bool 0,1 0 "1" indicates abort
XwsHasWarning Bool 0,1 0 "1" indicates a warning
XwsErrorIsUnexpected Bool 0,1 0 "1" indicates error was unexpected
XwsApiStatusCode String S,F,X S S = success, F = fail, X = internal unexpected error
XwsApiLogRef String 20220503-203503720-C3F60470A60147E7AA2315AB99693028--FaxAdmin-ApiTest Unique reference to any generated request logs
XwsReturnData String 2220426191230860986 Varies by method; Usually the internal Object Id of the related object
XwsResultCode Int 0 0 for success or result code on failure
XwsResultInfo String Result Info Corresponding to the ResultCode
XwsRemoteClientIp String 11.22.33.44 Remote client IP address
XwsRemoteClientIpSource String ClientAddr Remote client IP source
XwsErrorCode Int 0 for Success or Error Code on Failure
XwsErrorInfo String Error info corresponding to the Error Code
XwsErrorInfoEx String Extended error info if needed
XwsExternalKey String External key passed from the invoking application
XwsExternalInfo String External info passed from the invoking application

Sample XML Response Envelope

<ServiceResponse 
     ServiceName=""
     ServiceMethod=""
     RequestId=""
     RequestDate=""
     ResponseDate=""
     Success=""
     Abort=""
     HasWarning=""
     ApiStatusCode=""
     ApiLogRef=""
     ReturnData=""
     ResultCode=""
     ResultInfo=""
     ResultInfoEx=""
     ErrorCode=""
     ErrorInfo=""
     ErrorInfoEx=""
     RemoteClientIp=""
     RemoteClientIpSource=""
     ExternalKey=""
     ExternalInfo="">
   <ResponseData> varies by service method </ResponseData>
   <ResponseTrace> error or debug stack trace </ResponseTrace>
</ServiceResponse>
Attribute Type Values Sample Description
ServiceName String Container Name of the Service Class being invoked
ServiceMethod String ContainerInfo Name of the Method being invoked
RequestId String 1234512345 Unique generated GUID of the Request; Used for tracing and logging
RequestDate Date 2022-04-29T00:03:24Z UTC Timestamp when the Request was received
ResponseDate Date 2022-04-29T00:03:24Z UTC Timestamp when the Response was completed
Success Bool 0,1 1 "True" or "1" indicates method success. "False" or "0" indicates failure
Abort Bool 0,1 0 "1" indicates abort
HasWarning Bool 0,1 0 "1" indicates a warning
ErrorIsUnexpected Bool 0,1 0 "1" indicates error is unexpected
ApiStatusCode String S,F,X S S = success, F = fail, X = internal unexpected error
ApiLogRef String Unique reference to any generated logs for the request
ReturnData String 2220426191230860986 Varies by method; Usually the internal Object Id of the related object
ResultCode Int 0 0 for success or result code on failure
ResultInfo String Result Info Corresponding to the ResultCode
ResultInfoEx String Method specific extended result info
ErrorCode Int 0 0 for Success or Error Code on Failure
ErrorInfo String Error Info Corresponding to the ErrorCode
ErrorInfoEx String Extended error info if needed
RemoteClientIp String Remote client IP address
RemoteClientIpSource String Remote client IP source
ExternalKey String External key passed from the invoking application
ExternalInfo String External info passed from the invoking application

App Application Service Methods

GET App.ApiTest

Used to Test Connectivity and API Protocol Handshaking

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
IsError
boolean
 Set IsError = 1 to Generate an Error Response
InputData
string
 Will Be Included in Response Headers and XML Payload 'ReturnData' Field
Responses
XwsResultCode XwsResultInfo
0 Success
4001 Simulated Error
403 Security Validation Failed / Security Configuration Missing

GET App.AppVersionHistory

Retrieves Current App Build Version Information along with Installation & Update History

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Configuration Missing

GET App.AppVersionInfo

Retrieves Current App Build Version Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Configuration Missing

User Service Methods to Manage Users

GET FaxAdmin.QueryUserFaxBridge

Retrieves a User's FaxBridge Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.QueryUserInfo

Retrieves User Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Look Up
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.QueryUserRoutes

Retrieves a User's Routing Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserAdd

Adds a New User to a Specified Tenant

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
UserName *Required
string
 Unique Username
Password *Required
string
 Password Must Be At Least 6 Characters and Contain 1 Digit, 1 Uppercase, and 1 Lowercase Character
Email
string
 Must Be a Valid Email Address
Phone
string
 General Phone Number
Fax
string
 General Fax Number
FirstName
string
 User's First Name
LastName
string
 User's Last Name
DisplayName
string
 General Display Name
Company
string
 User's Company Name
ExternalID
string
 An External ID for User
ExternalRef
string
 An External Reference for User
IsActive
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
400 Duplicate Username / Duplicate Email
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.UserDelete

Removes a User

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to be Removed
Responses
XwsResultCode XwsResultInfo
0 Success
400 User Delete Not Allowed (Only Admin Under Tenant)
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyActive

Modifies a User's Active Status

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyBillingConfig

Modifies a User's Billing Configuration

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
BillingCode *Required
string
 General Billing Code for Reporting
BillingStatementDay
integer
 General Billing Statement Day
BillingStartYear
integer
 General Billing Start Year
BillingStartMonth
integer
 General Billing Start Month
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyCompany

Modifies a User's Company Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
Company *Required
string
 User's Company Name
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyCoverPage

Modifies a User's System Cover Page

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
CoverPage *Required
string
 User's System Cover Page
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User or Cover Page Not Found / Access Denied

GET FaxAdmin.UserModifyFaxAreaCode

Modifies a User's Fax Area Code

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
FaxAreaCode *Required
integer
 Typically 3 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyFaxBridge

Modifies FaxBridge Configuration Options for a User

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User Assigned to FaxBridge
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
FaxBridgePort
integer
 FaxBridge Port Number; Must Always Be 1
NotifyFlagsSend
boolean
 0 = Do Not Print Send Confirmations, 1 = Print Confirmation After Faxes Sent
NotifyFlagsRecv
boolean
 0 = Do Not Deliver Received Faxes to Device, 1 = Always Deliver Received Faxes to Device, 2 = Deliver Received Faxes to Device Based on Schedule
UpdateSchedule
boolean
 0 = Do Not Use Schedule for Received Fax Notification, 1 = Use Schedule for Received Fax Notification
ScheduleDayMask
integer
 Days of Week for Schedule; 1 = Mon, 2 = Tue, 4 = Wed, 8 = Thu, 16 = Fri, 32 = Sat, 64 = Sun. E.g. 12 = Wed & Thur
ScheduleStartTime
integer
 24 Hour Format for Schedule Start Time – HHMM
ScheduleEndTime
integer
 24 Hour Format for Schedule End Time – HHMM
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied
404 FaxBridge Not Found

GET FaxAdmin.UserModifyFaxCSID

Modifies a User's Fax CSID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
FaxCSID *Required
string
 Must Be 20 Characters Max
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyFaxCallerID

Modifies a User's Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify Fax Caller ID Of
FaxCallerID *Required
long
 Must Be an Existing Fax Caller ID Owned by the Tenant or a Route Assigned to the User - If left blank, the User's Caller ID Will Be Unset
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied
404 Caller ID Does Not Exist or Is Not Owned By the User's Tenant

GET FaxAdmin.UserModifyFaxTimeZone

Modifies a User's Timezone

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 Unique Username Field
FaxTimeZone *Required
string
 HAWAII, ALASKA, PACIFIC, ARIZONA, MOUNTAIN, CENTRAL, EASTERN
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyInfo

Modifies a User's Profile Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
Phone
string
 General Phone Number
FirstName
string
 User's First Name
LastName
string
 User's Last Name
DisplayName
string
 General Display Name
Company
string
 User's Company Name
CoverPage
string
 User's System Cover Page
FaxCSID
string
 Must Be 20 Characters Max
FaxCallerID
long
 Must Be an Existing Fax Caller ID Owned by the Tenant or a Route Assigned to the User
FaxAreaCode
integer
 Typically 3 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied
404 Cover Page Not Found / Caller ID Does Not Exist or Is Not Owned By the User's Tenant

GET FaxAdmin.UserModifyName

Modifies a User's Name

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
FirstName
string
 User's First Name
LastName
string
 User's Last Name
DisplayName
string
 General Display Name
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyPassword

Modifies a User's Password

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
Password *Required
string
 Password Must Be At Least 6 Characters and Contain 1 Digit, 1 Uppercase, and 1 Lowercase Character
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyPhone

Modifies a User's Phone

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
Phone *Required
string
 General Phone Number
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyPrimaryEmail

Modifies a User's Primary Email

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
EmailAddress *Required
string
 Must Be a Valid Email Address
NotifyFlagsSend
integer
 0 = Fax Send Notifications Off, 1 = Notify Only on Success, 2 = Notify Only on Failure, 3 = Always Notify
NotifyFlagsRecv
integer
 0 = Fax Receive Notifications Off, 1 = Notify Only on Success, 2 = Notify Only on Failure, 3 = Always Notify
AttachmentFormatSend
string
 Attachment Format for Fax Send Notifications; Example: pdf, none
AttachmentFormatRecv
string
 Attachment Format for Fax Receive Notifications; Example: pdf, none
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyPrimarySMS

Modifies a User's Primary Sms Address

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
SmsAddress *Required
string
 Sms Address for Notifications
NotifyFlagsSend
integer
 0 = Fax Send Notifications Off, 1 = Notify Only on Success, 2 = Notify Only on Failure, 3 = Always Notify
NotifyFlagsRecv
integer
 0 = Fax Receive Notifications Off, 1 = Notify Only on Success, 2 = Notify Only on Failure, 3 = Always Notify
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyPrivilege

Modifies a User's Priviledge Level

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
Privilege *Required
string
 Specify Priviledge Level as 'admin' or 'user'
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserModifyRestricted

Modifies a User's Restricted Status

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
IsRestrict *Required
boolean
 Flag for Restricted Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserQuotaDefaultSet

Modifies a User's Deafult Monthly Page Quota

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
QuotaPages *Required
string
 User Default Monthly Page Quota
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserQuotaModifyEnabled

Enables/Disables a User's Page Quota

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
IsEnabled *Required
boolean
 Flag for Quota Enabled Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserQuotaMonthlyAdd

Add Pages to a User's Monthly Quota

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
QuotaPagesToAdd *Required
integer
 Number of Pages to Add
ApplyToDate 
string
 Will Be Added to the Billing Period of the Specified Date
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxAdmin.UserQuotaMonthlySet

Sets a User's Monthly Quota

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Modify
QuotaMonthlyPages *Required
integer
 Number of Pages
ApplyToDate 
string
 Quota Will Be Set for the Billing Period of the Specified Date
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

Tenant Service Methods to Manage Tenants

GET FaxAdmin.QueryTenantInfo

Retrieves Tenant Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant Code to Look Up
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantAdd

Adds a New Tenant

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
NewTenantCode *Required
string
 Tenant Code Must Be At Least 3 Characters Without Spaces, and Must Be Unique
NewTenantName *Required
string
 Display Name of New Tenant
ParentTenantCode *Required
string
 Parent Tenant Code of New Tenant
NewTenantAdminPwd *Required
string
 Password Must Be At Least 6 Characters and Contain 1 Digit, 1 Uppercase, and 1 Lowercase Character
NewTenantTypeReseller *Required
string
 1 for Reseller Type, 0 for Customer
Responses
XwsResultCode XwsResultInfo
0 Success
400 Duplicate Tenant Code / Sub Tenants Not Allowed
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing

GET FaxAdmin.TenantDelete

Removes a Tenant

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantFaxBridgeList

Retrieves a List of FaxBridges Owned by a Tenant

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
DeviceFilter
integer
 Search for a matching device code
IncSubTenant
integer
 1 to include sub tenant faxbridges
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyActive

Modifies a Tenant's Active Status

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyApiEnable

Enables/Disables API Access for a Tenant

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
IsEnabled *Required
boolean
 Flag for Enabled Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyBillingCode

Modifies a Tenant's Billing Code

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
BillingCode *Required
string
 General Billing Code for Reporting
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyCoverPage

Modifies a Tenant's Cover Page

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
CoverPage *Required
string
 System Cover Page Option
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyFaxAreaCode

Modifies a Tenant's Fax Area Code

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
AreaCode *Required
integer
 Typically 3 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyFaxCountryCode

Modifies a Tenant's Fax Country Code

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
CountryCode *Required
integer
 Country Code Must Be Between 1 and 3 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyFaxLocalCSID

Modifies a Tenant's Fax Local CSID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
LocalCSID *Required
string
 Must Be 20 Characters Max
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyFaxLocalCallerID

Modifies a Tenant's Fax Local Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
LocalCallerID *Required
long
 Must Be an Existing Fax Caller ID or Route Owned by the Tenant - If left blank, the Tenant's Caller ID Will Be Unset
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied
404 Caller ID Does Not Exist or Is Not Owned By the Tenant

GET FaxAdmin.TenantModifyFaxTimeZone

Modifies a Tenant's Timezone

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 Unique Username Field
FaxTimeZone *Required
string
 HAWAII, ALASKA, PACIFIC, ARIZONA, MOUNTAIN, CENTRAL, EASTERN
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantModifyInfo

Modifies a Tenant's Profile Information

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
TenantName
string
 Tenant Display Name
Description
string
 Tenant Description
CoverPage
string
 System Cover Page
BillingCode
string
 General Billing Code for Reporting
FaxLocalCSID
string
 Must Be 20 Characters Max
FaxLocalCallerId
long
 Must Be an Existing Fax Caller ID or Route Owned by the Tenant
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied
404 Cover Page Not Found / Caller ID Does Not Exist or Is Not Owned By the Tenant

GET FaxAdmin.TenantModifyUserSuffix

Modifies a Tenant's Username Suffix

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Tenant to Modify
UserSuffix *Required
string
 Username Suffix Must Be At Least 3 Characters Without Spaces, and Must Be Unique
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

Fax Route Service Methods to Manage Global Fax Routes

GET FaxAdmin.FaxRouteAdd

Adds a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
TenantCode *Required
string
 Unique Tenant Code
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied
404 Route Already Exists

GET FaxAdmin.FaxRouteDelete

Removes a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied

GET FaxAdmin.FaxRouteManagerAssign

Assigns a Manager Tenant for a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
TenantCode *Required
string
 Unique Tenant Code
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied

GET FaxAdmin.FaxRouteModifyActive

Modifies the Active Status of a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied

GET FaxAdmin.FaxRouteOwnerAssign

Assigns an Owner Tenant for a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
TenantCode *Required
string
 Unique Tenant Code
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 Tenant Not Found

GET FaxAdmin.FaxRouteOwnerUnassign

Unassigns an Owner Tenant for a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied

GET FaxAdmin.FaxRouteRemoveAllUsers

Removes All Users from a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied

GET FaxAdmin.FaxRouteSetBillingUser

Sets Billing User for a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 User Not Found

GET FaxAdmin.FaxRouteUserAdd

Adds a User Assignment to a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsPrimary
boolean
 Flag for Primary Status
IsBillingUser
boolean
 Flag for Billing Status
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 User Not Found

GET FaxAdmin.FaxRouteUserAssign

Assigns a User to a Global Fax Route and Removes All Other Assigned Users from Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsPrimary *Required
boolean
 Flag for Primary Status
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 User Not Found

GET FaxAdmin.FaxRouteUserDelete

Removes a User Assignment from a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 User Not Found

GET FaxAdmin.FaxRouteUserModifyActive

Modifies the Active Status of User Assignment to a Global Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 User Not Found

GET FaxAdmin.FaxRouteUserModifyPrimary

Sets a User Assignment to a Global Fax Route as Primary / Not Primary

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsPrimary *Required
boolean
 Flag for Primary Status
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied
404 User Not Found

GET FaxAdmin.QueryFaxRouteInfo

Retrieves Information for a Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Route Not Found or Access Denied

Tenant Fax Route Service Methods to Manage Local Fax Routes

GET FaxAdmin.TenantFaxRouteAdd

Adds a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied
404 Route Already Exists

GET FaxAdmin.TenantFaxRouteDelete

Removes a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant or Route Not Found

GET FaxAdmin.TenantFaxRouteInfo

Retrieves Information for a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant or Route Not Found

GET FaxAdmin.TenantFaxRouteList

Retrieves a List of Fax Routes Owned by a Tenant

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RouteFilter
integer
 Search for matching routing digits
RouteScope
integer
 0 for all routes, 1 for global, 2 for local routes
IncSubTenant
integer
 1 to include sub tenant fax routes
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied

GET FaxAdmin.TenantFaxRouteModifyActive

Modifies a Local Fax Route's Active Status

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant or Local Route Not Found

GET FaxAdmin.TenantFaxRouteOwnerAssign

Assigns an Owner Tenant for a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant or Local Route Not Found

GET FaxAdmin.TenantFaxRouteOwnerUnassign

Unassigns an Owner Tenant for a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant or Local Route Not Found

GET FaxAdmin.TenantFaxRouteRemoveAllUsers

Removes All Users Assigned to a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
RoutingDigits *Required
long
 Up to 18 Numeric Digits
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant or Local Route Not Found

GET FaxAdmin.TenantFaxRouteSetBillingUser

Sets a Billing User for a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Local Route or User Not Found
404 User Not Assigned to Route

GET FaxAdmin.TenantFaxRouteUserAdd

Adds a User Assignment to a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsPrimary
boolean
 Flag for Primary Status
IsBillingUser
boolean
 Flag for Billing Status
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Local Route or User Not Found
404 User Not Assigned to Route

GET FaxAdmin.TenantFaxRouteUserAssign

Assigns a User to a Local Fax Route and Removes All Other Assigned Users from Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsPrimary
boolean
 Flag for Primary Status
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Local Route or User Not Found
404 User Not Assigned to Route

GET FaxAdmin.TenantFaxRouteUserDelete

Removes an Assigned User from a Local Fax Route

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Local Route or User Not Found
404 User Not Assigned to Route

GET FaxAdmin.TenantFaxRouteUserModifyPrimary

Sets a User Assignment to a Local Fax Route as Primary / Not Primary

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
RoutingDigits *Required
long
 Up to 18 Numeric Digits
UserName *Required
string
 Unique Username Field
IsPrimary *Required
boolean
 Flag for Primary Status
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Local Route or User Not Found
404 User Not Assigned to Route

Fax Caller IDs Service Methods to Manage Fax Caller IDs

GET FaxAdmin.FaxCidAdd

Adds a Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxNbr *Required
long
 Fax Caller ID to Add; Value must be between 8 and 18 numeric digits
TenantCode *Required
string
 Owner Tenant of the Fax Caller ID
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Tenant Not Found or Access Denied
404 Fax Caller ID Already Exists or Is Already Defined as a Global Fax Route

GET FaxAdmin.FaxCidDelete

Deletes a Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxNbr *Required
long
 Fax Caller ID to Delete
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Caller ID Not Found or Access Denied

GET FaxAdmin.FaxCidInfo

Retrieves Info for a Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxNbr *Required
long
 Fax Caller ID to Retrieve Info On
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Caller ID Not Found or Access Denied

GET FaxAdmin.FaxCidModifyActive

Modifies Active Status for a Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxNbr *Required
long
 Fax Caller ID to Modify Active Status Of
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Caller ID Not Found or Access Denied

GET FaxAdmin.FaxCidOwnerAssign

Assigns the Owner Tenant for a Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxNbr *Required
long
 Existing Fax Caller ID
TenantCode *Required
string
 New Owner Tenant for Fax Caller ID
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Caller ID or Tenant Not Found / Access Denied

GET FaxAdmin.FaxCidUnassignUsers

Unassigns All Users from a Fax Caller ID

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxNbr *Required
long
 Existing Fax Caller ID to Unassign Users From
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Caller ID Not Found or Access Denied

FaxBridge Service Methods to Manage FaxBridge Devices

GET FaxAdmin.FaxBridgeAdd

Adds a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TenantCode *Required
string
 Unique Tenant Code
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
Ports *Required
integer
 Ports = 1, 2, 3, 4
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
CountryCode
integer
 General Country Code for Tenant
AreaCode
integer
 3 Numeric Digits Typically
Responses
XwsResultCode XwsResultInfo
0 Success
400 Duplicate Device Code
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing

GET FaxAdmin.FaxBridgeDelete

Removes a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied

GET FaxAdmin.FaxBridgeManagerAssign

Assigns the Managing Tenant for a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
TenantCode *Required
string
 Unique Tenant Code
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied
404 Tenant Not Found

GET FaxAdmin.FaxBridgeModifyActive

Modifies the Active Status of a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
IsActive *Required
boolean
 Flag for Active Status; Value Must Be 0 for False or 1 for True
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied

GET FaxAdmin.FaxBridgeOwnerAssign

Assigns a Tenant as Owner of a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
TenantCode *Required
string
 Unique Tenant Code
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied
404 Tenant Not Found

GET FaxAdmin.FaxBridgeOwnerUnassign

Unassigns a Tenant as Owner of a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
TenantCode *Required
string
 Unique Tenant Code
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied
404 Tenant Not Found

GET FaxAdmin.FaxBridgePortAssign

Assigns a FaxBridge Port to a User

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
PortNumber *Required
integer
 FaxBridge port number; must always be 1
UserName *Required
string
 Unique Username Field
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied
404 Tenant Not Found

GET FaxAdmin.FaxBridgePortUnassign

Unassigns a FaxBridge Port

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
PortNumber *Required
integer
 FaxBridge port number; must always be 1
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Device Not Found or Access Denied
404 Tenant Not Found

GET FaxAdmin.QueryFaxBridgeInfo

Retrieves Information for a FaxBridge Device

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
FaxBridgeDevice *Required
long
 Should Be 12 Digits and Start with 2 and Ends with 0
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / FaxBridge Not Found or Access Denied

Inbound Service Methods for Inbound Faxes

GET FaxAdmin.FaxInfo

Retrieves Information for a Single Fax

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TransmissionId
string
 Fax Transmission ID
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Not Found
405 Unauthorized

GET FaxApi.InboundFaxDownload

Downloads the Contents of an Inbound Fax Specified by its Transmission Id

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TransmissionId *Required
string
 Fax transmission Id
FileName 
int
 Optional Name for the File Downloaded
AsAttachment  
boolean
 Document Disposition (0 or 1); Specifying AsAttachment=1 will result in the Content-Disposition HTTP header on the response being set to “attachment”. In most browsers, this will result in the browser giving the user an “open or save” dialog.
BookmarkLabel 
string
 Optional Bookmark Label
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing
405 Unauthorized

GET FaxApi.InboundFaxRetrieveSet

Retrieves an Information Set for All Inbound Faxes

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
WatermarkId
string
 WatermarkId is in the CYYMMDDHHMMSSXXXXXX Format
DataIncludeFlags 
int
 Option to Return Extended Response Information. Values: 0, 1, 2, 4, 8
OutputFormat 
string
 Values: XML, CSV
OutputSeparator 
string
 Change the Field Separator Instead of a Comma
OutputEscapeChar
string
 Default is a Space
OutputMaxResults 
int
 Default is 500 Records
Simulate 
boolean
 1 = Keeps the Watermark from Moving
Responses
XwsResultCode XwsResultInfo
0 Success
204 Method Call Too Frequent
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing

Outbound Service Methods for Outbound Faxes

GET FaxAdmin.FaxInfo

Retrieves Information for a Single Fax

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TransmissionId
string
 Fax Transmission ID
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing / Fax Not Found
405 Unauthorized

POST FaxApi.OutboundFaxCreate

Creates an Outbound Fax

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
UserName *Required
string
 User to Send Fax from, Must Be Under XSC Tenant
RecipientFax *Required
string
 Target Fax Destination with Country Code
FileName *Required
string
 Uploaded File Name
FileType *Required
string
 Extension for Uploaded File eg. pdf
RecipientName
string
 Recipient's Name for Cover Pages
RecipientCompany
string
 Recipient's Company for Cover Pages
RecipientPhone 
string
 Recipient's Phone for Cover Pages
RecipientEmail  
string
 Recipient's Email for Cover Pages
SenderName
string
 Sender's Name for Cover Pages
SenderCompany
string
 Sender's Company for Cover Pages
SenderPhone 
string
 Sender's Phone for Cover Pages
SenderEmail 
string
 Sender's Email for Cover Pages
SenderFax 
string
 Sender's Fax Number for Cover Pages
SenderCSID 
string
 Sender's Fax CSID for Fax Transmission
SenderCPN 
long
 Must Be an Existing Fax Caller ID or Route Owned by the Tenant
TrackingKey 
string
 General Tracking Key to Locate Fax Transmission
CoverPage 
string
 Option to Include Specific Cover Page
FaxHeader
string
 Specify a Custom Fax Header
FilterType 
string
 Specify a Filter Type Tag for Searching
FilterFolder 
string
 Specify a Filter Folder Tag for Searching
FilterNotes  
string
 Specify Filter Notes for Archiving
Subject   
string
 Subject for Cover Pages
Notes  
string
 Notes for Cover Pages
ChargeCode 
string
 General Charge Code for Reporting
CoverPageFlags 
boolean
 1 = Use User's Default Cover Page
NotifyFlags 
boolean
 1 = Use User's Default Notification Settings
Simulate 
boolean
 1 = Simulate Fax Transmission
MaxAttempts
int
 Max Attempts to Send Fax in the Workflow; when ommitted, this defaults to the Retry Schedule set in Advanced Settings. Inputted value cannot exceed attempts defined in the Retry Schedule.
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name / User Not Found / File Format Validate Failed / Fax Country Code Not Found / Unspecified File Type / Caller ID Does Not Exist or Is Not Owned By the User's Tenant
403 Security Validation Failed / Security Configuration Missing / User Not Found or Access Denied

GET FaxApi.OutboundFaxDownload

Downloads the Contents of an Outbound Fax Specified by its Transmission Id

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
TransmissionId *Required
string
 Fax transmission Id
FileName 
int
 Optional Name for the File Downloaded
AsAttachment  
boolean
 Document Disposition (0 or 1); Specifying AsAttachment=1 will result in the Content-Disposition HTTP header on the response being set to “attachment”. In most browsers, this will result in the browser giving the user an “open or save” dialog.
BookmarkLabel 
string
 Optional Bookmark Label
Responses
XwsResultCode XwsResultInfo
0 Success
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing
405 Unauthorized

GET FaxApi.OutboundFaxRetrieveSet

Retrieves an Information Set for All Outbound Faxes

Parameters
Name Description
XM *Required
string
 Method Signature
XSC *Required
string
 Security Context
XSK *Required
string
 Security Key
WatermarkId
string
 WatermarkId is in the CYYMMDDHHMMSSXXXXXX Format
DataIncludeFlags 
int
 Option to Return Extended Response Information. Values: 0, 1, 2, 4, 8
OutputFormat 
string
 Values: XML, CSV
OutputSeparator 
string
 Change the Field Separator Instead of a Comma
OutputEscapeChar
string
 Default is a Space
OutputMaxResults 
int
 Default is 500 Records
Simulate 
boolean
 1 = Keeps the Watermark from Moving
Responses
XwsResultCode XwsResultInfo
0 Success
204 Method Call Too Frequent
4000 A Required Parameter Failed Validation or is Missing, See XwsErrorInfo for Parameter Name
403 Security Validation Failed / Security Configuration Missing