Admin
The Interfax Admin web service enables the manipulation of Accounts and users directly from customer applications. This includes opening,closing,configuring and obtaining current status of Accounts and Users. Build 2017-07-07
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAccountDocumentProperty
Add account document properties -
AddGroupCoverpage
Add group cover page -
AddNewCostCenter
Add new cost center -
AddNewIPAddressRange
Get all ip addresses by account/user -
AddRxEmailProperties
[Deprecated - use AddRxEmailProperties_2] Add a recipient to an existing inbound service -
AddRxEmailProperties_2
Add a recipient to an existing inbound service -
AddRxService
Deprecated. Use AddRxServiceEx instead -
AddRxServiceEx
Creates a new inbound service under an existing user -
AddTxService
Creates a new Tx service under an existing user -
AddUserCoverpage
Add user cover page -
AddUserGroupToAccount
Add a user group to an account -
AddUserToGroup
Add a user to a group -
Add_Tx_Account
Add Tx Account(an email address from which user can send fax from) -
AuthenticateUser
Checks username & password validation -
AuthenticateUser2
Checks username & password validation and return a session token (from service) -
AuthenticateUserWithIPAddresses
Checks username & password & IPAddress validation and return a session token (from secure site) -
AuthenticateUserWithIPAddressesEx
Checks username & password & IPAddress validation and return a session token (from secure/UIC sites) -
BlockUser
Blocks a user from logging in to the secure site -
CalculateOfficeCost
calculate sending cost for office user -
ChangePassword
Change user's password -
ClearPayment
Continue with Multi hop Card Charge process -
ClearSessionToken
Erase the session Token -
CloseUser
Closes an active user and all its services -
CreateCoverpage
Creates new cover page -
CreateUserAppPassword
CreateUserAppPassword -
DeleteCoverpage
Delete cover page -
DeleteIPAddress
Get all ip addresses by account/user -
DeleteUserAppPassword
DeleteUserAppPassword -
GetAccountAuthenticationOptions
Set Account Authentication Options -
GetAccountCoverpage
Returns account's cover page by id -
GetAccountCoverpages
Returns account's cover pages of primary user's account -
GetAccountDCBalance
Returns current balance in Ledger of the specified account -
GetAccountDefaultSetting
Get account default settings -
GetAccountDisabledFeatures
Get account's disabled features -
GetAccountDocumentProperties
Get the account document properties -
GetAccountDocumentPropertiesEx
Get the account document properties EX -
GetAccountExternalPaymentMeans
Get the account's external payment means -
GetAccountPPCardsBalance
[Deprecated - use GetAccountPPCardsBalance2] Get the account's Prepaid cards balance -
GetAccountPPCardsBalance2
Get the account's Prepaid cards balance (C-friendly) -
GetAccountProperties
Get account's properties -
GetAccountRetentionPolicy
Get account and document retention policy -
GetAccountUsers
Returns account's users of primary user's account -
GetAccountUsersEx
Get all users in the account and their properties as a collection of Name/Value properties -
GetAccountUsersEx2
Get the requested 'Page' of users in the account and their properties as a collection of Name/Value properties -
GetAccountUsersEx3
Get the requested filtered 'Page' of users in the account and their properties as a collection of Name/Value properties -
GetAccountUsersRxProperties
Get inbound properties for all users in the primary user's account -
GetAllErrorCodes
Returns list of all error codes and their respective description -
GetAllUserPreferences
Obtain user preferences for a given user -
GetBankAccount
Returns bank account details -
GetBillingCountries
Get List of Billing Countries along with their currencies -
GetCC
Returns credit card details -
GetChargeRecord
Fetch the Charge process record for ChargeRef -
GetCostCenters
Retrieve a list of all cost centers -
GetCountries
Returns all countries isocodes and their names in the language required -
GetCountry
Returns country's properties in the language required -
GetCoverpageGroups
Returns list of groups which cover page is assigned to -
GetCoverpageUsers
Returns list of users which cover page is assigned to -
GetCoverpagesAssignedToGroup
Returns group cover pages -
GetCoverpagesAssignedToUser
Returns user cover pages -
GetDCList
Returns Ledger transaction of the specified account in a descending order (most recent is first) -
GetDestinationPrices
Get List of prices for sending pages in the appropriate currency and language -
GetErrorDescription
Returns an error message based on code -
GetGroupsForAccount
Get all groups in the primary user's account -
GetGroupsForUser
Get all groups in which the queried user is a member of -
GetIPAddresses
Get all ip addresses by account/user -
GetInboundActivity
Get the account's Inbound activity -
GetInboundNodes
[Deprecated - use GetInboundNodes_2] Get List of available inbound nodes -
GetInboundNodes_2
Get List of available inbound nodes -
GetInboundPrices
Get List of inbound prices for the appropriate currency and language -
GetInvoice
Returns Invoice data for given InvoiceID -
GetInvoiceDocument
Returns Invoice entire document (HTML) for given InvoiceID -
GetLitePrices
Get List of Lite prices for the appropriate Country and language -
GetLitePricesByGroup
Get List of Lite prices for the appropriate Subscription group and language -
GetOutPricesForExistingUser
Get List of outbound prices for an existing account. -
GetOutboundActivity
Get the account's Outbound activity -
GetOutboundPrices
Get List of outbound prices in the appropriate currency and language -
GetOutboundPricesEx
Get brand's list of outbound prices in the appropriate currency and language -
GetPDFInvoiceDocument
Returns Invoice as base 64 string of PDF file content for given InvoiceID -
GetReceiptDocument
Returns Receipt entire document (HTML) for given ReceiptID -
GetRxEmailProperties
[Deprecated - use GetRxEmailProperties_2] Get an existing inbound service recipient's properties -
GetRxEmailProperties_2
Get an existing inbound service recipient's properties -
GetRxServiceProperties
[Deprecated - use GetRxServiceProperties_2] Get an existing inbound service properties -
GetRxServiceProperties_2
Get an existing inbound service properties -
GetSupportedCharsetEncodings
Returns all InterFax supported character set encodings -
GetSupportedFonts
Returns all InterFax supported text fonts -
GetUserAppPasswords
GetUserAppPasswords -
GetUserCoverpages
Returns user cover pages assigned directly to him or through a group or public cover pages in the same account -
GetUserGeneralProperties
Returns general properties of the user -
GetUserGeneralPropertiesByPrimary
Returns the properties of the user UserID who is a member of the supplied primary user's account -
GetUserGoogle
Obtain users's google access details -
GetUserProperties
[Deprecated - use GetUserProperties_2] Get users' general properties -
GetUserPropertiesEx
Get users' general properties -
GetUserPropertiesEx2
Get user's properties as a collection of Name/Value properties -
GetUserProperties_2
Deprecated. Use GetUserPropertiesEx instead -
GetUserRx2TxProperties
Get users' rx2tx properties -
GetUserTXAccounts
Returns all the emails addresses from which user can send faxes from -
GetUserTxProperties
[Deprecated - use GetUserTxProperties_2] Get users' outbound properties -
GetUserTxProperties_2
Get users' outbound properties -
GetUserTxProperties_3
Get users' outbound properties -
GetUsersContactBySearchPattern
Obtain up to 20 user contacts for a given account by a search pattern -
GetUsersContactInfoInGroup
Get all users and their contact info in a group -
GetUsersInCostCenter
Retrieve a list of cost center's users -
GetUsersOutgoingCount
Returns an array of structures. Each structures contains a username and the ammount of faxes he sent between DateLowerBound and DateUpperBound. The users returned will be the members of the account of the primary user supplied -
GetusersInGroup
[Obsolete] Get all usernames in a group -
MoveUsersToCostCenter
Move users to cost center -
OpenUser
Creates a new user under an existing account, using Primary User properties and standard authentication srength -
OpenUserHighStrength
Creates a new user under an existing account, using Primary User properties and high authentication srength -
RefreshSessionToken
Extends Token time to last user activity, last 15 minutes -
RemoveAccountDocumentProperty
Remove account document property -
RemoveCostCenter
Remove cost center -
RemoveGroupCoverpage
Remove group cover page -
RemoveRxEmail
Remove a recipient from an existing inbound service -
RemoveRxEmailEx2
Extended function : Remove a recipient from an existing inbound service -
RemoveRxService
Closes an existing inbound service -
RemoveTxService
Closes an existing Tx service under an existing user -
RemoveUserCoverpage
Remove user cover page -
RemoveUserFromGroup
Remove a user from a group -
RemoveUserGoogle
Remove users's google access details -
RemoveUserGroupFromAccount
Remove a user group from an account -
RemoveUsersFromCostCenter
Remove users from cost center -
Remove_Tx_Account
Removes Tx Account(an email address from which user can send fax from -
RenameAccountDocumentProperty
Rename account document property -
RenameUserGroup
Rename a user group -
RestoreDefaultAccountRetentionPolicy
Restore account retention policy -
SaveChargeRecord
Fetch the Charge process record for ChargeRef -
SendCertificateToEmails
send certificates to emails requested -
SendPassword2
Sends password to user's email -
SetAccountAuthenticationOptions
Set Account Authentication Options -
SetAccountDefaultSetting
Set account default settings -
SetAccountProperties_2
Update account's properties -
SetBankAccountDetails
Updates/Add accounts's bank account details -
SetCCDetails
Updates/Add accounts's cc details -
SetCCDetails_Ex
Updates/Add accounts's cc details -
SetCoverpageGroups
Set cover page groups -
SetCoverpageUsers
Set cover page users -
SetRxEmailProperties
[Deprecated - use SetRxEmailProperties_2] Update an existing inbound service recipient's properties -
SetRxEmailProperties_2
Update an existing inbound service recipient's properties -
SetRxServiceProperties
[Deprecated - use SetRxServiceProperties_2] Update an existing inbound service properties -
SetRxServiceProperties_2
Update an existing inbound service properties -
SetUserGoogle
Updates/Add users's google access details -
SetUserProperties
[Depricated: use SetUserProperties_2 instead] Update user's general properties -
SetUserPropertiesEx
Update user's general properties as Name/Value collection -
SetUserProperties_2
Deprecated: use SetUserPropertiesEx instead -
SetUserRx2Tx
Add rx2tx properties for required user. -
SetUserTxProperties
Update users' outbound properties -
SetUserTxProperties_2
Update users' outbound properties -
SetUserTxProperties_3
Update users' outbound properties -
UnblockUser
Unblocks a user -
UpdateAccountRetentionPolicy
Update account retention policy -
UpdateCostCenter
Update cost center -
UpdateCoverpage
Update cover page -
UpdateDocumentRetentionPolicy
Update document retention policy -
ValidateAddresses
Validate account address