 |
XM Fax Web Service
Soap API to send and manage faxes
|
|
XM Fax Web Service
Soap API to send and manage faxes
|
The main class of SEI of FAX Web Service. More...
Public Member Functions | |
| FaxResult | sendFax ( @WebParam(name="userId") String userId, @WebParam(name="subject") String subject, @WebParam(name="comment") String comment, @WebParam(name="recipient") List< FaxRecipient > recipients, @WebParam(name="attachment") List< AttachedFile > attachments, @WebParam(name="coverPage") String coverPage, @WebParam(name="senderInfo") SenderInfo senderInfo, @WebParam(name="faxOptions") FaxOptions faxOptions, @WebParam(name="additionalData") AdditionalData additionalData, @WebParam(name="isCommentTypeHtml") Boolean isCommentTypeHtml) throws FaxException |
| Send a fax. More... | |
| FaxResult | sendFaxLater ( @WebParam(name="userId") String userId, @WebParam(name="subject") String subject, @WebParam(name="comment") String comment, @WebParam(name="recipient") List< FaxRecipient > recipients, @WebParam(name="attachment") List< AttachedFile > attachments, @WebParam(name="coverPage") String coverPage, @WebParam(name="senderInfo") SenderInfo senderInfo, @WebParam(name="faxOptions") FaxOptions faxOptions, @WebParam(name="additionalData") AdditionalData additionalData, @WebParam(name="delayUntil") XMLGregorianCalendar delayUntil, @WebParam(name="isCommentTypeHtml") Boolean isCommentTypeHtml) throws FaxException |
| Send a fax at the specified date. More... | |
| UserProfile | getUserProfile ( @WebParam(name="userId") String userId) throws FaxException |
| Find the profile of users by providing their SMTP address. More... | |
| boolean | verifyUserPassword ( @WebParam(name="userId") String userId, @WebParam(name="password") String password, @WebParam(name="otp") String otp) throws FaxException |
| Verify the credential of a user. More... | |
| Version | getVersion () |
| This method returns the version. More... | |
| InboundUserFaxResponse | findInboundFaxes ( @WebParam(name="userId") String userId, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount, @WebParam(name="sortInfo") InboundSortInfo sortInfo) throws FaxException |
| Find the fax(es) in the inbound history, for a specified user. More... | |
| InboundUserFaxResponse | findInboundFaxesAdvanced ( @WebParam(name="userId") String userId, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount, @WebParam(name="sortInfo") InboundSortInfo sortInfo, @WebParam(name="searchInfo") InboundUserSearchInfo searchInfo, @WebParam(name="keywordInfo") InboundUserKeywordInfo keywordInfo) throws FaxException |
| Find the fax(es) in the inbound history by providing search information, for a specified user. More... | |
| InboundUserFaxItemFull | getInboundFax ( @WebParam(name="faxId") String faxId) throws FaxException |
| Obtain the properties, including the image, of a fax in the inbound history. More... | |
| InboundUserFaxItemFull | getInboundFaxAdvanced ( @WebParam(name="faxId") String faxId, @WebParam(name="faxFormat") FaxFormat faxFormat, @WebParam(name="maxPages") Integer maxPages, @WebParam(name="bannerLocation") BannerLocation bannerLocation, @WebParam(name="locale") String locale, @WebParam(name="timezone") String timezone, @WebParam(name="upscaleImage") Boolean upscaleImage) throws FaxException |
| Obtain the properties, including the image, of a fax in the inbound history. More... | |
| OutboundUserFaxResponse | findOutboundFaxes ( @WebParam(name="userId") String userId, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount, @WebParam(name="sortInfo") OutboundSortInfo sortInfo) throws FaxException |
| Find the fax(es) in the outbound history, for a specified user. More... | |
| OutboundUserFaxResponse | findOutboundFaxesAdvanced ( @WebParam(name="userId") String userId, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount, @WebParam(name="sortInfo") OutboundSortInfo sortInfo, @WebParam(name="searchInfo") OutboundUserSearchInfo searchInfo, @WebParam(name="keywordInfo") OutboundUserKeywordInfo keywordInfo) throws FaxException |
| Find the fax(es) in the outbound history by providing search information, for a specified user. More... | |
| OutboundUserFaxItemFull | getOutboundFax ( @WebParam(name="faxId") String faxId) throws FaxException |
| Obtain the properties, including the image, of a fax in the outbound history. More... | |
| OutboundUserFaxItemFull | getOutboundFaxAdvanced ( @WebParam(name="faxId") String faxId, @WebParam(name="faxFormat") FaxFormat faxFormat, @WebParam(name="maxPages") Integer maxPages, @WebParam(name="bannerLocation") BannerLocation bannerLocation, @WebParam(name="locale") String locale, @WebParam(name="timezone") String timezone, @WebParam(name="upscaleImage") Boolean upscaleImage) throws FaxException |
| Obtain the properties, including the image, of a fax in the outbound history. More... | |
| OutgoingFaxResponse | findOutgoingFaxes ( @WebParam(name="userId") String userId, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount) throws FaxException |
| Find the fax(es) in the outgoing queue, for a specified user. More... | |
| OutgoingFaxResponse | findOutgoingFaxesAdvanced ( @WebParam(name="userId") String userId, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount, @WebParam(name="searchInfo") OutgoingSearchInfo searchInfo) throws FaxException |
| Find the fax(es) in the outgoing queue by providing search information, for a specified user. More... | |
| OutgoingFaxItemFull | getOutgoingFax ( @WebParam(name="faxId") String faxId) throws FaxException |
| Obtain the properties, including the image, of a fax in the outgoing queue. More... | |
| OutgoingFaxItemFull | getOutgoingFaxAdvanced ( @WebParam(name="faxId") String faxId, @WebParam(name="faxFormat") FaxFormat faxFormat, @WebParam(name="maxPages") Integer maxPages, @WebParam(name="upscaleImage") Boolean upscaleImage) throws FaxException |
| Obtain the properties, including the image, of a fax in the outgoing queue. More... | |
| void | markAsViewed ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Mark the fax(es) as viewed/read in inbound and outbound history. More... | |
| void | markAsUnviewed ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Mark the fax(es) as unviewed/unread in inbound and outbound history. More... | |
| void | cancel ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Cancel fax(es) in the outgoing queue. More... | |
| void | cancelBroadcast ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Cancel fax(es) broadcast in the outgoing queue. More... | |
| List< FaxResult > | resubmit ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Resubmit the fax(es). More... | |
| List< FaxResult > | resubmitTo ( @WebParam(name="faxId") List< String > faxId, @WebParam(name="destination") String destination) throws FaxException |
| Resubmit the fax(es) to a specific number. More... | |
| List< FaxResult > | resubmitLater ( @WebParam(name="faxId") List< String > faxId, @WebParam(name="destination") String destination, @WebParam(name="delayUntil") XMLGregorianCalendar delayUntil) throws FaxException |
| Resubmit the fax(es) to a specific number at the specified date. More... | |
| void | retrySendingNow ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Retry sending the given fax(es) from the Outgoing Queue. More... | |
| void | markAsDeleted ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Delete the fax(es) from the user view in Inbound or Outbound History. More... | |
| void | markAsUndeleted ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Restore the fax(es) to the user view in Inbound or Outbound History. More... | |
| void | deletePermanently ( @WebParam(name="faxId") List< String > faxId) throws FaxException |
| Permanently remove fax(es) from the user Inbound or Outbound History. More... | |
| void | saveNote ( @WebParam(name="faxId") String faxId, @WebParam(name="note") String note) throws FaxException |
| Set the user's note for a fax. More... | |
| void | setAdditionalData ( @WebParam(name="faxId") String faxId, @WebParam(name="custom1") String custom1, @WebParam(name="custom2") String custom2, @WebParam(name="custom3") String custom3, @WebParam(name="custom4") String custom4, @WebParam(name="custom5") String custom5) throws FaxException |
| Set additional data for a fax. More... | |
| void | forward ( @WebParam(name="faxId") List< String > faxId, @WebParam(name="destination") List< Destination > destinations) throws FaxException |
| Forward fax(es). More... | |
| DestinationSearchResponse | findDestinations ( @WebParam(name="userId") String userId, @WebParam(name="searchQuery") String searchQuery, @WebParam(name="type") String type, @WebParam(name="maxCount") int maxCount) throws FaxException |
| Search in the Notification Destinations for a forward destination. More... | |
| PhonebookSearchResponse | findContacts ( @WebParam(name="userId") String userId, @WebParam(name="searchQuery") String searchQuery, @WebParam(name="maxCount") int maxCount) throws FaxException |
| Search contacts from the phonebook. More... | |
| PhonebookSearchResponse | findContactsPerPage ( @WebParam(name="userId") String userId, @WebParam(name="searchQuery") String searchQuery, @WebParam(name="startIndex") int startIndex, @WebParam(name="maxCount") int maxCount) throws FaxException |
| Search contacts from the phonebook, with a start index. More... | |
| List< PhonebookPerson > | getPersonsInGroupRecursive ( @WebParam(name="groupId") String[] groupId) throws FaxException |
| Get all the persons that are members of a group recursively. More... | |
| void | addContact ( @WebParam(name="userId") String userId, @WebParam(name="contact") PhonebookPerson contact) throws FaxException |
| Add a person in the personal phonebook of the specified user Required fields are name and fax. More... | |
| void | updateContact ( @WebParam(name="userId") String userId, @WebParam(name="contact") PhonebookPerson contact) throws FaxException |
| Update a person in the personal phonebook Required fields are phonebook id, name and fax. More... | |
| void | addGroup ( @WebParam(name="userId") String userId, @WebParam(name="name") String name) throws FaxException |
| Add a group in the personal phonebook of the specified user. More... | |
| void | updateGroup ( @WebParam(name="userId") String userId, @WebParam(name="group") PhonebookGroup group) throws FaxException |
| Update a group in the personal phonebook of the specified user. More... | |
| String | getUserData ( @WebParam(name="userId") String userId, @WebParam(name="dataId") String dataId) throws FaxException |
| Get data associated to a user. More... | |
| void | setUserData ( @WebParam(name="userId") String userId, @WebParam(name="dataId") String dataId, @WebParam(name="data") String data) throws FaxException |
| Set the data for a given id (key) associated to a user. More... | |
| AuditLogResponse | getAuditLogs ( @WebParam(name="faxId") String faxId) throws FaxException |
| Get the audit logs for a specific fax. More... | |
| List< FaxBoxDelegation > | getFaxBoxDelegations ( @WebParam(name="siteId") String siteId) throws FaxException |
| To get all the fax box delegations for a given site. More... | |
| List< FaxBoxDelegate > | getFaxBoxDelegates ( @WebParam(name="faxBoxId") String faxBoxId) throws FaxException |
| To get all the fax box delegates for a given fax box. More... | |
| List< FaxBox > | getAccessibleFaxBoxes ( @WebParam(name="delegateId") String delegateId) throws FaxException |
| To get all the fax boxes accessible by a given user via delegation. More... | |
| void | addFaxBoxDelegate ( @WebParam(name="faxBoxId") String faxBoxId, @WebParam(name="delegateId") String delegateId, @WebParam(name="options") FaxBoxDelegationOptions options) throws FaxException |
| Add a delegate on a fax box. More... | |
| void | updateFaxBoxDelegate ( @WebParam(name="faxBoxId") String faxBoxId, @WebParam(name="delegateId") String delegateId, @WebParam(name="options") FaxBoxDelegationOptions options) throws FaxException |
| Update the options for a given delegate on a fax box. More... | |
| void | deleteFaxBoxDelegates ( @WebParam(name="faxBoxId") String faxBoxId, @WebParam(name="delegateId") List< String > delegateIds) throws FaxException |
| To remove delegates from a fax box. More... | |
| void | setPhonebookService (PhonebookService phonebookService) |
The main class of SEI of FAX Web Service.
The purpose of FAX Web Service is to send a FAX, to monitor and to manage it in different folders.
1.9.5