Fax Broadcast Web Services

Transcription

1 Fax Broadcast Web Services

2 Table of Contents WEB SERVICES PRIMER... 1 WEB SERVICES... 1 WEB METHODS... 1 SOAP ENCAPSULATION... 1 DOCUMENT/LITERAL FORMAT... 1 URL ENCODING... 1 SECURE POSTING... 1 FAX BROADCAST WEB METHODS... 2 SENDING... 3 Web Method - SendFaxBroadcast()... 3 REPORTING... 7 Web Method GetFaxStatus()... 8 Web Method GetFaxStatusCSV() Web Method GetDetailFaxStatus() Web Method GetDetailFaxStatusCSV() APPENDIX A - RETURN CODE TABLES STATUS AND ERROR CODE DESCRIPTIONS Status Result Codes Transmission Result Codes WEB SERVICES RETURN MESSAGES Successful Return Messages User Error Messages Internal Error Messages APPENDIX B LOCATIONS OF RESOURCES SENDING REPORTING APPENDIX C SUPPORTED FILE FORMATS PIPSUGMSFWS i

3 Web Services Primer Web Services Web Services are a collection of web based applications that provide business functionality through an internet connection. They use standard Internet protocols such as HTTP, XML, and SOAP to provide interconnectivity and interoperability between companies. Web Services provide component based functionality that can be used and re-used without regard to the details of the service implementation. Web Services run on a web server, and allow client programs to access the hosted applications by calling Web Methods. Web Methods Web methods provide the mechanism for a remote application to access (or consume) a specific application running on Web Services. Each of Protus web methods is available through a URI and is accessed via either a plain HTTP POST request or SOAP over HTTP POST. When using plain HTTP POST, the data will be structured using URL Encoding. When using SOAP over HTTP POST the data will be structured as an XML document. Web methods will typically provide responses structured as XML documents for both plain HTTP and SOAP over HTTP posts, which will at a minimum indicate the success or failure status of the post. SOAP Encapsulation SOAP (Simple Object Access Protocol) defines an envelope format and rules for describing its contents. SOAP is used here as a wrapper for posting requests to and responses from the various web methods contained in the web services. Document/Literal Format The posting methods provided support only Document/Literal formatted messages. If you are using a SOAP toolkit that does not support Document/Literal, we recommend that you write your own HTTP POST or SOAP over HTTP POST requests. URL Encoding URL Encoding is the structure typically employed when posting with plain HTTP. This means that the argument s name and value should be separated by an equal sign ( = ) and each such pairing separated by an ampersand ( & ). Neither the equal sign nor ampersand should be included as data when URL encoding. This is in accordance with the World Wide Web consortium specifications. For example: UserID=12345&Password=abcdefg Secure Posting Since all of our HTTP posting methods described actually employ HTTPS, security of all data transmitted over our Web Services is ensured. PIPSUGMSFWS

4 Fax Broadcast Web Methods Fax Broadcast Web Services are Internet fax services based on industry standard XML technology. Fax Broadcast Web Services are designed for developers to enable them to create secure applications that send, receive, and report on faxes over the World Wide Web. Fax Broadcast Web Services expose the following simple web methods for developers to integrate Fax Broadcasting into their applications: Sending o Fax Submission SendFaxBroadcast() Reporting o Basic GetFaxStatus() o Basic CSV GetFaxStatusCSV() o Detailed GetDetailFaxStatus() o Detailed CSV GetDetailFaxStatusCSV() PIPSUGMSFWS

5 Sending Fax Broadcast Sending enables an organization or business to automate the distribution of faxes and to integrate the service within their own business systems, applications, or software. Fax Broadcast Sending web methods convert an electronic document and deliver it as a fax to multiple destinations, with no fax hardware or software required, using simple Internet protocols. File types supported for the document to be faxed include Microsoft Word (.doc) and Adobe Acrobat (.pdf). For more information on supported file types, see Supported File Formats. Multiple documents, having the same or different file types, may be included in a single submission. Web Method - SendFaxBroadcast() This web method is provided to send faxes, consisting of one or more document files, to multiple fax destinations. Location This Web Service is located at: Inputs SchemaVersion login_key login_key user_id login_key user_ login_key user_password fax_broadcast_options Instances Type Length / Values Default One Container NA NA Root element of the SendFaxBroadcast XML document. Contains: login_key, fax_broadcast_options, fax_recipient,_list, document_list One String NA NA The version of the schema being used. Currently this value must be set to 1.1 as that is the only version supported. One Container NA NA User identification and authentication. Contains: user_id, user_ , user_password. One Integer 1 to NA Use either user_id or user_ , not both. Contains the id number of the user account. One String 60 chars NA Use either user_id or user_ , not both. Contains the address assigned to the account user. One String 20 chars NA Contains the password associated with the account user id. One Container NA NA Special options to be applied to the fax send. Contains: billing_code, from_name, start_hour, end_hour, release_date, legal_size_flag, tiff_image_flag, max_successful, resolution. PIPSUGMSFWS

6 fax_broadcast_options billing_code fax_broadcast_options from_name fax_broadcast_options start_hour fax_broadcast_options end_hour fax_broadcast_options release_date fax_broadcast_options legal_size_flag fax_broadcast_options tiff_image_flag fax_broadcast_options max_successful fax_broadcast_options resolution fax_recipient_list fax_recipient_list fax_recipient_number fax_recipient_list fax_recipient_name fax_recipient_list fax_recipient_reference Instances Type Length / Values Default Zero or String 128 chars Dependant One on account settings Alphanumeric identifier that appears in reports, but not on the faxed document. Zero or One String 50 chars Dependant on account settings Appears in fax banner to identify who sent the fax. Zero or One Numeric Indicates hour that fax broadcast should begin. Zero or Numeric One Indicates hour that fax broadcast should end. Zero or DateTime NA One YYYY- MM- DDTHH: MM:SS Indicates date on which fax broadcast should be released. Zero or One Boolean true false false Specifies that the system must convert the document to legal size paper. The default is letter size for all documents. Zero or One Boolean true false true Specifies that the document provided is a TIFF image requiring no further conversion. Zero or Integer NA 0 One Sets the maximum number of successful destinations in a fax broadcast. The broadcast will terminate when this number is reached. 0 indicates no maximum. Zero or One Enumeration low high low Specifies whether a document should be converted to a low (draft) or high (fine) resolution TIFF image. One Container NA NA Describes the recipients of the fax document. Contains: fax_recipient_number, fax_recipient_name, fax_recipient_reference for each recipient. One Numeric String 7 20 digits NA Contains the destination fax number beginning with the country code Zero or String 50 chars One Contains the destination name that will appear in the To field on the fax banner. Zero or String 50 chars One Contains reference information about each fax recipient. PIPSUGMSFWS

7 document_list document_list document document_list document attribute: document_content_type document_list document attribute: document_encoding_type document_list document attribute: document_extension Instances Type Length / Values Default One Container NA NA Specifies a list of one or more documents to be faxed. Contains: document One to 25 Encoded NA NA File Contains document to be faxed as an encoded file, as defined by the document attributes. Has attributes: document_content_type, document_encoding_type, document_extension One String NA NA Defines content type of document, for example, text/plain. One Enumeration Base64 uuencode quotedprintable bin hex none NA Defines encoding type used to encode the document. One Alphanumeric 3 chars NA Provides the file extension of the original document. HTTP Post Requests Follow this guideline when posting with SOAP: POST /protus/xmlwebservices/xmlsubmitter/messaging.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <SendFaxBroadcast xmlns=" <XmlDocument>string</XmlDocument> </SendFaxBroadcast> </soap:body> </soap:envelope> Follow this guideline when posting without SOAP: POST /protus/xmlwebservices/xmlsubmitter/messaging.asmx/sendfaxbroadcast HTTP/1.1 Host: Content-Type: application/x-www-form-urlencoded XmlDocument=string PIPSUGMSFWS

8 Where string represents an XML file, such as: < xmlns=" xmlns:xsi=" xsi:schemalocation=" sfax_schema.xsd"> <SchemaVersion>1.0</SchemaVersion> <login_key> <user_id>12345</user_id> <user_password>abcd123</user_password> </login_key> <fax_broadcast_options> <billing_code>cust 123</billing_code> <from_name>john Doe</from_name> <start_hour>0</start_hour> <end_hour>23</end_hour> <release_date< t00:00:00</release_date> <legal_size_flag>false</legal_size_flag> <tiff_image_flag>false</tiff_image_flag> <max_successful> <resolution>low</resolution> <fax_recipient_list> <fax_recipient> <fax_recipient_number> </fax_recipient_number> <fax_recipient_name>jane Doe</fax_recipient_name> <fax_recipient_reference>widgetsinternational</fax_recipient_reference> <fax_recipient> <fax_recipient> <fax_recipient_number> </fax_recipient_number> <fax_recipient_name>john Doe</fax_recipient_name> <fax_recipient_reference>widgetsrus</fax_recipient_reference> <fax_recipient> </fax_recipientlist> <document_list> <document document_content_type="text/plain" document_encoding_type="none" document_extension="txt">greetings to our licensed re-sellers: Here are the are the specials for next month. Acme Widgets</document> <document document_content_type="application/msword" document_encoding_type="base64" document_extension="doc">0m8r4kgxgueaaaaaaaaaaaaaaaaaaaaapgadap7/cqagaaaaaaaaaaaaaaab AAAAJgAAAAAA AAAAEAAAKQAAAAEAAAD+////AAAAACcAAAD///////////////////////////////////// //////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////... (lines omitted)... AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=</document> </document_list> </single_fax_info> Outputs SendFaxBroadcastResult SendFaxBroadcastResult Header SendFaxBroadcastResult Header ErrorFlag SendFaxBroadcastResult Header ReturnMessage Instances Type Length / Values Default One Container NA NA Root element of the SendFaxBroadcast response. Contains: Header, TransactionID, NumberOfDestinations. One Container NA NA Status information resulting from the SendFaxBroadcast submission. Contains: ErrorFlag, ReturnMessage. One Boolean true false NA Specifies whether an error occurred. True indicates an error; false indicates no error. One String NA NA Return message for SendFaxBroadcast submission. See Return Messages for details. PIPSUGMSFWS

9 SendFaxBroadcastResult TransactionID SendFaxBroadcastResult NumberOfDestinations Instances Type Length / Values Default One Numeric 7 digits NA String Unique number that can be used to identify the submitted job in all reports. One Integer NA NA Number of destinations submitted with fax request. HTTP Post Response The response to a SOAP over HTTP post will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <SendFaxBroadcastResponse xmlns=" <SendFaxBroadcastResult> <Header> <ErrorFlag>boolean</ErrorFlag> <ReturnMessage>string</ReturnMessage> </Header> <TransactionID>string</TransactionID> <NumberOfDestinations>int</NumberOfDestinations> </SendFaxBroadcastResult> </SendFaxBroadcastResponse> </soap:body> </soap:envelope> </soap:envelope> The response to an HTTP post without SOAP will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <SendResponse xmlns=" <Header> <ErrorFlag>boolean</ErrorFlag> <ReturnMessage>string</ReturnMessage> </Header> <TransactionID>string</TransactionID> <NumberOfDestinations>int</NumberOfDestinations> </SendResponse> Reporting Fax Broadcast Services tracks faxes once the fax broadcast has been successfully submitted. The system tracks in real time from submission to successful delivery to a fax machine and stores tracking information for up to a year after completion. The Fax Broadcast Reporting Service can be polled on a regular basis for complete information regarding one or many fax broadcasts through one simple request. Reports can be generated based upon one master account or on all the users within a master account. PIPSUGMSFWS

10 Detailed fax transmission reports are available based upon the following criteria: The transaction identifier provided by the Fax Broadcast Service The transaction ID is returned to the user once the Fax Broadcast Service successfully receives the SendFaxBroadcast request. The system generates detailed reports based on one transaction ID or on a comma-delimited list of up to 100 transaction IDs. Note that if any transaction IDs are specified, all other filter specifications are ignored. A unique identifier assigned to the fax transmission by the user (also called the Billing Code and/or reference ID) Upon fax broadcast submission, the user can assign a unique identifier to the fax broadcast. A fax transmission report can be generated based on the unique ID assigned by the user. Note that if a billing code is specified, then a period of less than 24 hours must also be specified for the report. A specified time period All fax transmissions within a certain period can be reported on using the Fax Broadcast Reporting Services. Note that a period of less than 24 hours must be specified for the report. The destination fax numbers Reports can be generated based on one fax destination or on a comma-delimited list of up to 100 fax destinations. Note that if a fax number is specified, then a period of less than 24 hours must also be specified for the report. By default, if only the account number, password, and AllUsers flag are specified, then the Fax Reporting Services will report on the last 24-hour period of fax transmissions. Web Method GetFaxStatus() This web method is provided to request a summary report on transmissions to broadcast destinations. This report requires the User ID and Password for authentication. For non-master user IDs, the report only contains data applicable to that user. For master, account holder, user IDs, the report contains a choice of data applicable only to that user or data applicable to all users associated with that account. For master agent accounts, the report contains all master account activities. Location This Web Service is located at: Inputs Instances Type Length / Values Default PIPSUGMSFWS

11 GetFaxStatus GetFaxStatus UserID GetFaxStatus UserPassword GetFaxStatus AllUsersFlag GetFaxStatus BillingCodeFilter GetFaxStatus TransactionIDListFilter GetFaxStatus StartTimeStampFilter GetFaxStatus EndTimeStampFilter GetFaxStatus FaxNumberListFilter Instances Type Length / Values Default One Container NA NA Root element of the GetFaxStatus request. Contains: UserID, UserPassword, AllUsersFlag, BillingCodeFilter, TransactionIDListFilter, StartTimeStampFilter,EndTimeStampFilter,FaxNumbersListFilter One Numeric String 1 to NA Specifies the User ID of the user that sent the fax request. One String 20 NA Specifies the password associated with the User ID. One Boolean true false NA Specifies if the report includes data applicable to all users associated with the account. One String 128 characters NA Specifies if the report only includes transactions for a particular billing code. One NA Numeric String Comma-delimited list of transaction IDs Specifies if the report only includes details associated with a particular transaction ID for a transmission. One DateTime YYYY-MM- DDTHH:MM:SS NA Specifies if the report only includes details associated with a transmission that started at a particular time. One DateTime YYYY-MM- DDTHH:MM:SS NA Specifies if the report only includes details associated with a transmission that ended at a particular time. One Numeric String Comma delimited list of fax numbers NA Specifies if the report only includes details associated with a transmission sent to a particular fax number. HTTP Post Requests Follow this guideline when posting with SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetFaxStatus xmlns=" <UserID>int</UserID> <UserPassword>string</UserPassword> <AllUsersFlag>boolean</AllUsersFlag> <BillingCodeFilter>string</BillingCodeFilter> <TransactionIDListFilter>string</TransactionIDListFilter> <StartTimeStampFilter>string</StartTimeStampFilter> <EndTimeStampFilter>string</EndTimeStampFilter> <FaxNumbersListFilter>string</FaxNumbersListFilter> </GetFaxStatus> </soap:body> PIPSUGMSFWS

12 </soap:envelope> Follow this guideline when posting without SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx/getfaxstatus HTTP/1.1 Host: Content-Type: application/x-www-form-urlencoded UserID=string&UserPassword=string&AllUsersFlag=string&BillingCodeFilter=string&Transac tionidlistfilter=string&starttimestampfilter=string&endtimestampfilter=string&faxnumbe rslistfilter=string Outputs Header Header ErrorFlag Header ReturnMessage FaxSummary FaxSummary AccountID FaxSummary UserID FaxSummary TransactionType FaxSummary TransactionID FaxSummary StatusCode Instances Type Length / Values Default One Container NA NA Root element of. Contains: One Container NA NA Result of GetFaxStatus. Contains Header, FaxSummary. One Container NA NA Status information resulting from the fax submission. One Boolean true false NA Specifies whether an error occurred. True indicates an error; false indicates no error. One String NA NA Return message for fax submission. See Fax Broadcast Method Return Messages for more information. One Container NA NA Fax Summary results corresponding to a single broadcast Transaction ID from the result set. Contains AccountID, UserID, TransactionType, TransactionID, StatusCode, BillingCode, ReceivedTimeStamp, ReleaseTimeStamp, CompletedTimeStamp, PagesPerDestination, NumberOfDestinations, NumberOfSuccessful, NumberOfFailed, TotalDuration, TotalCost. One Numeric String 1 to NA Specifies the master profile ID. One Numeric 1 to NA String Specifies the service, non-master, profile ID. This field is the same as the AccountID for accounts with only one user. One String 4 NA Indicates the type of transaction being reported, for example, WFFA indicates Web Fax with a fax attachment. One Numeric 1 to NA String Indicates a unique identifier for the single destination fax or broadcast. One Numeric NA NA String Indicates the status of a fax during transmission. See Status Result Codes for more information. One String 128 NA characters PIPSUGMSFWS

13 FaxSummary BillingCode FaxSummary ReceivedTimestamp FaxSummary ReleaseTimestamp FaxSummary CompletedTimestamp FaxSummary PagesPerDestination FaxSummary NumberOfDestinations FaxSummary NumberOfSuccessful FaxSummary NumberOfFailed FaxSummary TotalDuration FaxSummary TotalCost Instances Type Length / Values Default Specifies the billing code associated with the broadcast transmission. If no billing code is supplied, the field will be the same as the AccountID. One DateTime YYYY- NA MM- DDTHH: MM:SS Indicates the time the transaction was received by the system. One DateTime YYYY- NA MM- DDTHH: MM:SS Indicates the time the transaction was released by the system for processing. One DateTime YYYY- MM- DDTHH: MM:SS Indicates the time the broadcast is marked finished by system, corresponds to the delivery time of the last fax. One Numeric NA NA String Specifies the number of pages sent to each destination. One Numeric NA NA String Specifies the total number of broadcast destinations submitted. One Numeric NA NA String Indicates the real-time number of successfully delivered destinations. One Numeric NA NA String Indicates the real-time number of failed deliveries after the maximum number of retries. One Numeric NA NA String Indicates the total duration of all individual broadcast destinations. The value is 0 until the broadcast is complete. One Numeric To four NA String decimals Indicates the total cost of all individual broadcast destinations. HTTP Post Response The response to a SOAP over HTTP post will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> < xmlns=" < xmlns=" <Header> <ErrorFlag>boolean</ErrorFlag> <ReturnMessage>string</ReturnMessage> PIPSUGMSFWS

14 </Header> <FaxSummary> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <StatusCode>int</StatusCode> <BillingCode>string</BillingCode> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <ReleaseTimeStamp>dateTime</ReleaseTimeStamp> <CompletedTimeStamp>dateTime</CompletedTimeStamp> <PagesPerDestination>int</PagesPerDestination> <NumberOfDestinations>int</NumberOfDestinations> <NumberOfSuccessful>int</NumberOfSuccessful> <NumberOfFailed>int</NumberOfFailed> <TotalDuration>int</TotalDuration> <TotalCost>double</TotalCost>xml</FaxSummary> <FaxSummary> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <StatusCode>int</StatusCode> <BillingCode>string</BillingCode> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <ReleaseTimeStamp>dateTime</ReleaseTimeStamp> <CompletedTimeStamp>dateTime</CompletedTimeStamp> <PagesPerDestination>int</PagesPerDestination> <NumberOfDestinations>int</NumberOfDestinations> <NumberOfSuccessful>int</NumberOfSuccessful> <NumberOfFailed>int</NumberOfFailed> <TotalDuration>int</TotalDuration> <TotalCost>double</TotalCost>xml</FaxSummary> </> </> </soap:body> </soap:envelope> The response to an HTTP post without SOAP will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <FaxSummaryList xmlns=" <Header> <ErrorFlag>boolean</ErrorFlag> <ReturnMessage>string</ReturnMessage> </Header> <FaxSummary> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <StatusCode>int</StatusCode> <BillingCode>string</BillingCode> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <ReleaseTimeStamp>dateTime</ReleaseTimeStamp> <CompletedTimeStamp>dateTime</CompletedTimeStamp> <PagesPerDestination>int</PagesPerDestination> <NumberOfDestinations>int</NumberOfDestinations> <NumberOfSuccessful>int</NumberOfSuccessful> <NumberOfFailed>int</NumberOfFailed> <TotalDuration>int</TotalDuration> <TotalCost>double</TotalCost>xml</FaxSummary> <FaxSummary> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <StatusCode>int</StatusCode> <BillingCode>string</BillingCode> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <ReleaseTimeStamp>dateTime</ReleaseTimeStamp> PIPSUGMSFWS

15 <CompletedTimeStamp>dateTime</CompletedTimeStamp> <PagesPerDestination>int</PagesPerDestination> <NumberOfDestinations>int</NumberOfDestinations> <NumberOfSuccessful>int</NumberOfSuccessful> <NumberOfFailed>int</NumberOfFailed> <TotalDuration>int</TotalDuration> <TotalCost>double</TotalCost>xml</FaxSummary> </FaxSummaryList> Web Method GetFaxStatusCSV() This web method is provided to request a summary report on transmissions to individual and broadcast destinations in CSV format. This report requires the User ID and Password for authentication. For non-master user IDs, the report only contains data applicable to that user. For master, account holder, user IDs, the report contains a choice of data applicable only to that user or data applicable to all users associated with that account. For master agent accounts, the report contains all master account activities. Location This Web Service is located at: Inputs GetFaxStatusCSV GetFaxStatusCSV UserID GetFaxStatusCSV UserPassword GetFaxStatusCSV AllUsersFlag GetFaxStatusCSV BillingCodeFilter GetFaxStatusCSV TransactionIDListFilter GetFaxStatusCSV StartTimeStampFilter GetFaxStatusCSV EndTimeStampFilter Instances Type Length / Values Default One Container NA NA Root element of the GetFaxStatusCSV request. Contains: UserID, UserPassword, AllUsersFlag, BillingCodeFilter, TransactionIDListFilter, StartTimeStampFilter,EndTimeStampFilter,FaxNumbersListFilter One Numeric 1 to NA String Specifies the User ID of the user that sent the fax request. One String 20 NA Specifies the password associated with the User ID. One Boolean true false NA Specifies if the report includes data applicable to all users associated with the account. One String 128 characters NA Specifies if the report only includes transactions for a particular billing code. One NA Numeric String Comma-delimited list of transaction IDs Specifies if the report only includes details associated with a particular transaction ID for a transmission. One DateTime YYYY-MM- DDTHH:MM:SS NA Specifies if the report only includes details associated with a transmission that started at a particular time. One DateTime YYYY-MM- DDTHH:MM:SS NA Specifies if the report only includes details associated with a transmission that ended at a particular time. PIPSUGMSFWS

16 GetFaxStatusCSV FaxNumberListFilter Instances Type Length / Values Default One Numeric Comma-delimited NA String list of fax numbers Specifies if the report only includes details associated with a transmission sent to a particular fax number. HTTP Post Requests Follow this guideline when posting with SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetFaxStatusCSV xmlns=" <UserID>int</UserID> <UserPassword>string</UserPassword> <AllUsersFlag>boolean</AllUsersFlag> <BillingCodeFilter>string</BillingCodeFilter> <TransactionIDListFilter>string</TransactionIDListFilter> <StartTimeStampFilter>string</StartTimeStampFilter> <EndTimeStampFilter>string</EndTimeStampFilter> <FaxNumbersListFilter>string</FaxNumbersListFilter> </GetFaxStatusCSV> </soap:body> </soap:envelope> Follow this guideline when posting without SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx/getfaxstatuscsv HTTP/1.1 Host: Content-Type: application/x-www-form-urlencoded UserID=string&UserPassword=string&AllUsersFlag=string&BillingCodeFilter=string&Transac tionidlistfilter=string&starttimestampfilter=string&endtimestampfilter=string &FaxNumbersListFilter=string Outputs GetFaxStatusCSVResponse GetFaxStatusCSVResponse GetFaxStatusCSVResult Instances Type Length / Values Default One Container NA NA Root element of the GetFaxStatusCSVResponse. Contains: GetFaxStatusCSVResult One String NA NA Results of query in CSV format. Provides the same returned values as in the GetDetailFaxStatus Web Method in a comma-delimited value string. HTTP Post Response The response to a SOAP over HTTP post will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> PIPSUGMSFWS

17 <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetFaxStatusCSVResponse xmlns=" <GetFaxStatusCSVResult>string</GetFaxStatusCSVResult> </GetFaxStatusCSVResponse> </soap:body> </soap:envelope> The response to an HTTP post without SOAP will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <string xmlns=" Web Method GetDetailFaxStatus() This web method is provided to request a detailed report on transmissions to individual fax destinations. This report requires the User ID and Password for authentication. For non-master account IDs, the report only contains data applicable to that user. For master account IDs, account holder, user IDs, the report contains a choice of data applicable only to that user or data applicable to all users associated with that account. For master agent accounts, the report contains all master account activities. Location This Web Service is located at: Inputs UserID UserPassword AllUsersFlag BillingCodeFilter TransactionIDListFilter Instances Type Length / Values Default One integer 1 to NA Specifies the User ID of the user that sent the fax request. One String 20 NA Specifies the password associated with the User ID. One Boolean true false Specifies if the report includes data applicable to all users associated with the account. This is a required field. One String NA Specifies if the report is to include transactions for a particular billing code. If a BillingCodeFilter is specified, then a StartTimeStampFilter and EndTimeStampFilter must be specified and must be less than a 24- hour period. One String Comma-delimited list of transaction IDs Specifies if the report only includes details associated with a particular transaction ID for a fax transmission. Commas should separate lists of up to 100 transaction IDs. If transaction IDs are submitted, then all other filters are ignored. StartTimeStampFilter One DateTime YYYY-MM- NA DDTHH:MM:SS PIPSUGMSFWS

18 EndTimeStampFilter FaxNumberListFilter Instances Type Length / Values Default Specifies if the report only includes details associated with a transmission that started at a particular time. If no filters are specified, then a default of the last 24 hours is assumed. One DateTime NA Specifies if the report only includes details associated with a transmission that ended at a particular time. If no filters are specified, then a default of the last 24 hours is assumed. One Numeric Comma delimited NA String list of fax numbers Specifies if the report only includes details associated with a transmission sent to a particular fax number. Commas should separate lists of up to 100 fax numbers. If a FaxNumberListFilter is specified, then a StartTimeStampFilter and EndTimeStampFilter must be specified and must be less than a 24-hour period. HTTP Post Requests Follow this guideline when posting with SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetDetailFaxStatus xmlns=" <UserID>int</UserID> <UserPassword>string</UserPassword> <AllUsersFlag>boolean</AllUsersFlag> <BillingCodeFilter>string</BillingCodeFilter> <TransactionIDListFilter>string</TransactionIDListFilter> <StartTimeStampFilter>string</StartTimeStampFilter> <EndTimeStampFilter>string</EndTimeStampFilter> <FaxNumbersListFilter>string</FaxNumbersListFilter> </GetDetailFaxStatus> </soap:body> </soap:envelope> Follow this guideline when posting without SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx/getdetailfaxstatus HTTP/1.1 Host: Content-Type: application/x-www-form-urlencoded UserID=string&UserPassword=string&AllUsersFlag=string&BillingCodeFilter=string&Transac tionidlistfilter=string&starttimestampfilter=string&endtimestampfilter=string&faxnumbe rslistfilter=string Outputs Header Instances Type Length / Values Default One Container NA NA Root element of the GetDetailFaxStatus response. One Container NA NA Status information resulting from the web method call. Contains: ErrorFlag, ReturnMessage. PIPSUGMSFWS

19 Header ErrorFlag Header ReturnMessage FaxDetail FaxDetail AccountID FaxDetail UserID FaxDetail TransactionType FaxDetail TransactionID FaxDetail SubTransactionID FaxDetail StatusCode FaxDetail ErrorCode FaxDetail ReferenceID FaxDetail ReceivedTimestamp FaxDetail DeliveredTimestamp Instances Type Length / Values Default One Boolean true false NA Specifies whether an error occurred. True indicates an error; false indicates no error. One String NA NA Return message for fax submission. Zero or Container NA NA More Each instance of FaxDetail contains a list of fax detail information for a fax transmission. Contains: AccountID, UserID, TransactionType, TransactionID, SubTransactionID, StatusCode, ErrorCode, ReferenceID, ReceivedTimestamp, DeliveredTimestamp, NumberofPages, ToText, DestinationFaxNumber, DestinationCountryCode, Duration, FileSize, Retries, Cost. One Integer 1 to NA Specifies the master account ID. This ID is the billed entity. Multiple UserIDs map to one AccountID. One Integer 1 to NA Specifies the user ID. In the case where an AccountID is inputted in the request, the UserID will equal to the AccountID. One String 4 NA Indicates the type of transaction being reported, for example WFFA indicates Web Fax with a fax attachment. For a complete list of transaction types see the Appendix ****ADD THE REF**** One Integer 1 to NA Indicates the unique identifier for the single fax transmission. One Integer 1 to Will always equal 1 for single fax transmissions. One Integer 1 to One Indicates the status of a fax in progress. See Status Result Codes for more information. Integer 1 to NA Indicates any errors that may have occurred during transmission. For example, 0 indicates a successful fax transmission. See Transmission Error Codes for more information. One String 1 to 128 NA characters Specifies the individual destination billing code or reference field. One DateTime YYYY-MM- NA DDTHH:M M:SS Indicates the time a single fax transmission record is created on the system. One DateTime YYYY-MM- NA DDTHH:M M:SS Indicates the time a successful fax transmission is completed to the destination fax number. PIPSUGMSFWS

20 FaxDetail NumberOfPages FaxDetail ToText FaxDetail DestinationNumber FaxDetail DestinationCountryCode FaxDetail Duration FaxDetail FileSize FaxDetail Retries FaxDetail Cost Instances Type Length / Values Default One Integer NA NA Specifies the number of pages in the fax transmission. One String Free Format NA Specifies the name included in the To field. One String Fax Number NA beginning with the country code Specifies the destination number of a single destination fax. One Numeric NA NA String Indicates the country code portion of a fax number. For fax numbers in North America, the country code includes the country and area codes, for example One Integer 1 to NA Specifies the duration, in seconds, of a fax transmission. One Integer 1 to NA Specifies the size of the file, in bytes, of the entire fax transmission. One Integer -1 to 9 NA Indicates the number of retries remaining for a transmission. Retries are statically configured at the UserID level. Contact your account representative for more information. The number of Retries defaults to -1 for fax transmissions that have used and failed the number of retries set at the UserID level. One Numeric To four NA String decimals Specifies the total cost of the fax transmission including taxes if applicable. HTTP Post Response The response to a SOAP over HTTP post will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetDetailFaxStatusResponse xmlns=" < xmlns=" <Header> <ErrorFlag>boolean</ErrorFlag> <ReturnMessage>string</ReturnMessage> </Header> <FaxDetail> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <SubTransactionID>int</SubTransactionID> <StatusCode>int</StatusCode> <ErrorCodeID>int</ErrorCodeID> <ReferenceID>string</ReferenceID> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> PIPSUGMSFWS

21 <DeliveredTimeStamp>dateTime</DeliveredTimeStamp> <NumberOfPages>int</NumberOfPages> <ToText>string</ToText> <DestinationNumber>string</DestinationNumber> <DestinationCountryCode>int</DestinationCountryCode> <Duration>int</Duration> <FileSize>int</FileSize> <Retries>int</Retries> <Cost>double</Cost>xml</FaxDetail> <FaxDetail> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <SubTransactionID>int</SubTransactionID> <StatusCode>int</StatusCode> <ErrorCodeID>int</ErrorCodeID> <ReferenceID>string</ReferenceID> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <DeliveredTimeStamp>dateTime</DeliveredTimeStamp> <NumberOfPages>int</NumberOfPages> <ToText>string</ToText> <DestinationNumber>string</DestinationNumber> <DestinationCountryCode>int</DestinationCountryCode> <Duration>int</Duration> <FileSize>int</FileSize> <Retries>int</Retries> <Cost>double</Cost>xml</FaxDetail> </> </GetDetailFaxStatusResponse> </soap:body> </soap:envelope> The response to an HTTP post without SOAP will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <FaxDetailList xmlns=" <Header> <ErrorFlag>boolean</ErrorFlag> <ReturnMessage>string</ReturnMessage> </Header> <FaxDetail> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <SubTransactionID>int</SubTransactionID> <StatusCode>int</StatusCode> <ErrorCodeID>int</ErrorCodeID> <ReferenceID>string</ReferenceID> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <DeliveredTimeStamp>dateTime</DeliveredTimeStamp> <NumberOfPages>int</NumberOfPages> <ToText>string</ToText> <DestinationNumber>string</DestinationNumber> <DestinationCountryCode>int</DestinationCountryCode> <Duration>int</Duration> <FileSize>int</FileSize> <Retries>int</Retries> <Cost>double</Cost>xml</FaxDetail> <FaxDetail> <AccountID>int</AccountID> <UserID>int</UserID> <TransactionType>string</TransactionType> <TransactionID>int</TransactionID> <SubTransactionID>int</SubTransactionID> <StatusCode>int</StatusCode> <ErrorCodeID>int</ErrorCodeID> <ReferenceID>string</ReferenceID> <ReceivedTimeStamp>dateTime</ReceivedTimeStamp> <DeliveredTimeStamp>dateTime</DeliveredTimeStamp> PIPSUGMSFWS

22 <NumberOfPages>int</NumberOfPages> <ToText>string</ToText> <DestinationNumber>string</DestinationNumber> <DestinationCountryCode>int</DestinationCountryCode> <Duration>int</Duration> <FileSize>int</FileSize> <Retries>int</Retries> <Cost>double</Cost>xml</FaxDetail> </FaxDetailList> Web Method GetDetailFaxStatusCSV() This web method is provided to request a detailed report on transmissions to individual and broadcast destinations in CSV format. This report requires the User ID and Password for authentication. For non-master user IDs, the report only contains data applicable to that user. For master user IDs, account holder, the report contains a choice of data applicable only to that user or data applicable to all users associated with that account. For master agent accounts, the report contains all master account activities. Location This Web Service is located at: Inputs The inputs are the same as the inputs for the GetDetailFaxStatus web method. UserID UserPassword AllUsersFlag BillingCodeFilter TransactionIDListFilter StartTimeStampFilter Instances Type Length / Values Default One Integer 1 to NA Specifies the User ID of the user that sent the fax request. One String 20 NA Specifies the password associated with the User ID. One Boolean true false Specifies if the report includes data applicable to all users associated with the account. This is a required field. One String NA Specifies if the report only includes transactions for a particular billing code. If a BillingCodeFilter is specified, then a StartTimeStampFilter and EndTimeStampFilter must be specified and must be less than a 24 hour time period. One String Comma-delimited list of transaction IDs Specifies if the report only includes details associated with a particular transaction ID for a fax transmission. Lists of transaction IDs should be separated by commas. A maximum of 100 transaction IDs in the list are supported. If transaction IDs are submitted, then all other filters are ignored. One DateTime YYYY-MM- DDTHH:MM:SS Specifies if the report only includes details associated with a transmission that started at a particular time. If no filters are specified, then a default of the last 24 hours is assumed. EndTimeStampFilter One DateTime YYYY-MM- DDTHH:MM:SS PIPSUGMSFWS

23 FaxNumberListFilter Instances Type Length / Values Default Specifies if the report only includes details associated with a transmission that ended at a particular time. If no filters are specified, then a default of the last 24 hours is assumed. One Numeric Comma delimited String list of fax numbers Specifies if the report is to include details associated with a transmission sent to a particular fax number. Lists of Fax numbers should be separated by commas. A maximum of 100 fax numbers in the list are supported. If a FaxNumberListFilter is specified, then a StartTimeStampFilter and EndTimeStampFilter must be specified and must be less than a 24 hour time period. HTTP Post Requests Follow this guideline when posting with SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetDetailFaxStatusCSV xmlns=" <UserID>int</UserID> <UserPassword>string</UserPassword> <AllUsersFlag>boolean</AllUsersFlag> <BillingCodeFilter>string</BillingCodeFilter> <TransactionIDListFilter>string</TransactionIDListFilter> <StartTimeStampFilter>string</StartTimeStampFilter> <EndTimeStampFilter>string</EndTimeStampFilter> <FaxNumbersListFilter>string</FaxNumbersListFilter> </GetDetailFaxStatusCSV> </soap:body> </soap:envelope> Follow this guideline when posting without SOAP: POST /protus/xmlwebservices/xmlreports/statusreports.asmx/getdetailfaxstatuscsv HTTP/1.1 Host: Content-Type: application/x-www-form-urlencoded UserID=string&UserPassword=string&AllUsersFlag=string&BillingCodeFilter=string&Transac tionidlistfilter=string&starttimestampfilter=string&endtimestampfilter=string&faxnumbe rslistfilter=string Outputs GetDetailFaxStatusCSVRespo nse GetDetailFaxStatusCSVRespons e GetFaxStatusCSVResult Instances Type Length / Values Default One Container NA NA Root element of the One String NA NA Results of query in CSV format. PIPSUGMSFWS

24 HTTP Post Response The response to a SOAP over HTTP post will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetDetailFaxStatusCSVResponse xmlns=" <GetDetailFaxStatusCSVResult>string</GetDetailFaxStatusCSVResult> </GetDetailFaxStatusCSVResponse> </soap:body> </soap:envelope> The response to an HTTP post without SOAP will look like the following: HTTP/ OK Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <string xmlns=" PIPSUGMSFWS

25 Appendix A - Return Code Tables Status and Error Code s Status Result Codes Status Code 10 Transmission accepted. No processing on the transmission has occurred at this time. 15 File conversion in progress Broadcast on hold until specified future release date. (Does not apply to single transmissions.) 20 Transmission has successfully passed image conversion and is waiting for credit check to begin. 25 Checking account credit in progress Internal error. Contact support and provide transaction/reference ID. 120 Transmission has successfully passed file conversion and credit check and is waiting in buffer to dial number. 130 Transmission was completed successfully. 170 Transmission is dialing on resource or waiting at resource to be dialed. 190 Transmission failed. 195 Transmission is waiting to redial for specified redial retry interval (account default is three minutes). Transmission Result Codes Error Code 0 Successful Transmission 1 Unspecified Error Occurred 4 Line is Busy 5 No Answer 6 No Dial tone on Call Attempt 7 Voice (Human) Answered Call instead of Fax Tone 8 Unspecified Error Occurred 9 Fax TIFF File Bad Format or Corrupt 10 Fax Transmission Error (Cutoff) 11 Telco Error (Reorder Busy) 12 Telco Error (T1 Cannot Provide Dialing Allow) 13 Attachment Failed Conversion 14 Excluded Number or Number Blocked from Receiving 15 Answering Machine instead of Fax Tone 16 Invalid Number 17 Incorrect Password Used in Request 18 Unknown Error 21 Fax Transmission was Cut Off 22 Account Requires Billing Code and Billing Code was not Used PIPSUGMSFWS

26 PIPSUGMSFWS

27 Web Services Return Messages The return messages are divided in three categories: 1. Successful Return Messages The user request has been validated and received successfully. 2. User Error Messages The user request contains errors. The request needs to be corrected before re-submitting. 3. Internal Error Messages An error has occurred that does not appear to be a User error. Please, notify support. Successful Return Messages Successful Return Messages Action M2000: Faxes Received Successfully M2001: Faxes Deleted Successfully M2002: Faxes Deleted Successfully M2003: No Received Faxes Found M2004: No Physical Received Faxes Found in Archive M2005: Single Fax Request Received Successfully Faxes were found that match the specification in the request. The faxes that were specified were successfully deleted as requested. No received faxes were found to delete. No faxes were found that match the specification in the request. No physical received fazes were found in the archive. Your single fax request has been received successfully. M2006: Fax Broadcast Request Received Successfully M2007: Voice Broadcast Request Received Successfully M2008: The Requested Report Was Generated Successfully M2009: An Empty Report Was Generated Successfully M2010: New Account Created Successfully M2011: New User Successfully Created M2012: New Fax Number Successfully Added M2013: The Request Has Been Received. It May Take a Few Minutes to Take Effect. Your fax broadcast request has been received successfully. Your voice broadcast request has been received successfully. The requested report was generated successfully. The requested report did not return any results. This may happen if the Transaction ID specified was not found. A new user account has been created successfully. A new user account has been created successfully. A new fax number has been added successfully. A request has been received and is pending completion and implementation. Verify that the correct Transaction ID was specified in the request and try again. M2014: No Fax Number Found The indicated fax number Specify a valid Fax Number. PIPSUGMSFWS

28 Successful Return Messages Action To Delete M2015: Request Sucessfully Received M2016: User s Information Successfully Updated M2017: Successfully Deleted the Account M2018: Successfully Deleted the User M2019: Account s Information Successfully Updated M2020: Account was Successfully Created But is Not Active M2024: Information Updated Successfully M2025: Information Requested Successfully Returned M2026: Successfully Added M2027: Successfully Deleted M2028: All Accounts Have Been Successfully Created M2029: Some Accounts Have Been Successfully Created M2030: All Accounts Have Been Successfully Deleted M2031: Some Accounts Have Been Successfully Deleted M2032: Information Requested Was Not Found could not be found and therefore was not deleted. A request has been received successfully. A change to a user s information has been successfully made. An account has been successfully deleted. A user has been successfully deleted. The information for an account has been updated successfully. An account has been created but is not active. An information change has been successfully made. The requested information has been returned successfully. A new or updated address has been successfully added. An existing address has been successfully deleted. A set of accounts has been successfully created. A subset of accounts requested has been successfully created. A set of accounts has been successfully deleted. A subset of accounts requested has been successfully deleted. The requested information could not be found. Redo the request and resubmit. User Error Messages User Error Messages Action U1005: Error In Processing Faxes ID List U1006: Invalid Fax Number The Faxes ID list could not be processed because of an error. The Fax Number specified in the request is invalid or does not exist. Correct the error and redo the task. Specify a valid Fax Number. PIPSUGMSFWS

29 User Error Messages Action U1007: Start and End Timestamps Should Be Between <min>,<max> U1011: Invalid User ID U1012: Invalid Master Account ID U1013: Invalid Password U1014: The Sent TimeStamp Format is Invalid U1015: Requested Faxes Size Exceed The Limit <size> Bytes U1018: Invalid User U1022: The Input Xml File Is Not Valid U1023: The Xml Input File Does Not Confirm To The Schema U1027: The Fax Number Is Not Numeric U1028: No Attached Documents To Fax U1029: You Should Add a <connect_1> Section and Fill it With a Valid <connect_1_phone> When auto_connect Flag is True U1030: You Should Specify a Valid Value for <connect_1_digit> When auto_connect_flag is False U1031: You Should Specify the Recipients of Your Broadcast U1032: File With Invalid Sound Format U1033: Voice Answer File Name Cannot be Null U1034: Voice Answer File Was Not Sent In The Request and Was Not Found in Our Databases The date range specified must be within the date range for faxes archived by the account. <min> and <max> will be replaced by the actual corresponding timestamps. The user specified an invalid User ID. The user specified an invalid Master Account ID. The user specified an invalid Password. The user specified Sent TimeStamp Format is invalid. The size of the requested faxes exceeds the limit for downloading. <size> will be replaced by the actual size of the limit in bytes. The user specified an invalid . The user sent an invalid Xml file. The user sent a valid Xml file, but this file does not conform to Protus XML Schemas. The user specified a nonnumeric fax number. The user did not attach any documents to fax. If you are using the auto_connect flag, then you must specify a connect_1 section with a valid telephone number. If you are not using the auto_connect flag, then you must specify a connect_1 section with a valid digit. You must specify the recipients of your broadcast. The file has an invalid sound format. The Voice Answer filename was not provided. The Voice Answer filename provided was not sent, nor can it be located in the database. Ensure that the date range being specified is within the date range for which received faxes are being archived. Specify a valid User ID. Specify a valid Master ID. Specify a valid Password. Specify a valid Sent TimeStamp. If requesting multiple faxes, try requesting them individually or contact Support for alternative means of obtaining the fax(es). Specify a valid . Fix the Xml file. The return message will contain additional information to pin-point the location of the error. Fix the Xml file. The return message will contain additional information to pin-point the location of the error. Use only numeric fax numbers. Attach at least one document to fax. Add the valid telephone number in the connect_1 section. Add the valid digit in the connect_1 section. Specify the recipients. Provide a valid sound format. Provide a valid filename. Provide a valid filename. PIPSUGMSFWS

30 User Error Messages Action U1035: Machine Answer File Name Cannot be Null U1036: Machine Answer File Name Was Not Sent In the Request and Was Not Found in Our Databases U1037: The SchemaVersion Value is Invalid U1038: The Start TimeStamp Should be less than the End TimeStamp U1039: The Difference Between Start and End TimeStamp Should be less than 744 hours U1039: The Difference Between Start and End TimeStamp Should be less than 24 hours U1040: The Requested Format Should be Either XML or CSV. U1041: The User Submitted One Or More Empty Documents U1042: The Voice Broadcast Request is Missing the Options Section U1043: Failed to Updated. User s Information is Invalid U1044: Could Not Find the Requested User U1045: Could Not Find the Requested Account U1046: Maximum Size Exceeded U1047: Login Name is Invalid U1048: Password is Invalid U1049: The is Already Being Used The machine answer file name was not provided. The machine answer filename provided was not sent, nor can it be located in the database. The Schema version was not recognized. The Start TimeStamp should be less than the End TimeStamp. For Summary Reports, the specified Start and End TimeStamps have more that 744 hours difference between them. For Detailed Reports, the specified Start and End TimeStamps have more that 24 hours difference between them. The file format must be either XML or CSV. The user has submitted one or more empty documents. You must specify the options section in a voice broadcast request. The information provided for the user is invalid and the update could not be completed. The system could not find the requested user. The system could not find the requested account. The maximum allowed size for an has been exceeded. The login name provided is invalid. The password provided is invalid. The specified address is already in use. Provide a valid filename. Provide a valid filename. Currently, the only valid schema version is 1.0. Use a Start Timestamp that occurs before the End TimeStamp. For Summary Reports, specifiy Start and End TimeStamps that have a difference less than 744 hours. For Detailed Reports, specifiy Start and End TimeStamps that have a difference less than 24 hours. Provide a file in either XML or CSV format. All attached documents cannot be empty. Remove an empty document tag or add a valid document. Specify the options section and resubmit the voice broadcast request. Ensure user information provided is valid. Check the user name and resubmit the request. Check the account information and resubmit the request. Reduce the size of the . Provide a valid login name. Provide a valid password. Provide a different address. U1050: Failed to Create a Fax Number The system failed to create a fax number. U1051: Agent Reseller Account is Not Active The provided agent reseller account is not active. PIPSUGMSFWS

31 User Error Messages Action U1052: Could Not Recognize the Account ID U1053: Could Not Recognize the User ID U1054: Cannot Delete a Master User U1055: Cannot Delete an Agent Account U1056: Cannot Delete An Account With An Outstanding Balance And the Reseller Does Not Do Own Billing U1057: The User is Not a Master User U1058: The Account to Delete is Not Owned by the Reseller U1059: The Account to Fetch is Not Owned by the Reseller U1060: The User to Delete is Not Owned By The Account U1061: You Are Not Allowed To Use This Web Application U1062: An Invalid Billing Day Was Passed In U1063: The Required Package Was Not Found U1064: The Sales Reseller Agent Master Profile Was Not Found U1065: You Are Not Allowed to Log Into This Application U1066: Request Failed Because a Null Value Was Passed U1067: Request Failed Because A Bad Formatted Argument Was Passed U1068: Request Failed Because Is Not Well Formatted U1069: You Cannot Add More Than The Maximum Allowed Sending s The system could not recognize the provided account ID. The system could not recognize the provided User ID. The user cannot delete a master account. The user cannot delete an agent account The account cannot be deleted because it has an outstanding balance. The system cannot delete a non-master user. The system cannot delete an account that is not owned by that reseller. The system cannot fetch an account that is not owned by that reseller. The system cannot delete a user that is not owned by that account. The user does not have the appropriate permissions to use the indicated web-based application. An invalid billing day was supplied to the system. A required package could not be located on the system The system could not locate the Sales Reseller Agent Master Profile. The user does not have the appropriate permissions to log into the requested application. An invalid null value was submitted. An incorrectly formatted argument was submitted. An incorrectly formatted was submitted. The maximum number of allowed s was exceeded. Provide a valid account ID. Provide a valid User ID. Confirm the ownership and attempt the deletion again. Confirm the ownership and attempt the fetch again. Confirm the ownership and attempt the deletion again. Check permissions and ensure they are appropriate for the desired application. Check the billing day and resubmit the information. Check with your system administrator. Check the information and resubmit the request. Obtain the appropriate permissions and attempt to log in again. Submit a valid value. Submit the argument in the correct format. Submit the in the correct format. PIPSUGMSFWS

32 User Error Messages Action U1070: You Cannot Delete the Master User U1071: Could Not Find The Requested To Delete U1072: A Passed In Argument Exceeded the Allowed Length U1073: The Maximum Allowed Archiving Period Has Been Exceeded U1074: The Minimum Allowed Archiving Period Is Zero U1075: The Required Fax Number Was Not Found U1076: You Cannot Add More Than the Maximum Allowed Receive s U1077: The Total Chars Length Of All Received s Cannot Exceed U1078: Could Not Add An Which is Already Added U1079: Could Not Delete An Which Is Not Found U1080: Could Not Delete The Only Left Fax Receive U1081: The Invoice Destination Value is Invalid U1082: The Usage Limit Value is Invalid U1083: You Are Not Allowed to Change An Account Setting U1084: The Value of the Month Should Be Between 1 and 12 U1085: The UserID Should Always Be a Positive Number U1086: Billing Code Is Either Null or Its Length Is Bigger than 128 Characters U1087: A Valid Year Ranges from 1900 Until Today s Year The user does not have the proper permissions to delete the Master User s . The requested address could not be found. An argument that was submitted is too long. The maximum period for which you can archive information has been exceeded. The minimum period for which you can archive information was not met. The fax number required by the system cannot be found. The maximum number of receiving s has been exceeded. The maximum number of characters in received s has been exceeded. The specified to add already exists. The specified does not exist and therefore could not be deleted. The user cannot delete the last fax number in a receive list. The value specified for the invoice destination is not valid. The value specified for the usage limit is invalid. The user does not have the appropriate permission to change the account setting. The user must submit a value between 1 and 12 for the month. A negative number was submitted as a userid. The billing code submitted was either null or in excess of 128 characters. An invalid year was entered. Obtain the appropriate permissions and attempt the deletion again. Verify the addres to be deleted and attempt the deletion again. Shorten the argument and resubmit it. Shorten the period of time for which you want to archive information and resubmit the request. Determine a valid minimum (above zero) and resubmit the request. Ensure the required fax information has been recorded. Reduce the number of receiving s and resubmit the request. Reduce the number of characters and resubmit the request. Confirm the invoice destination and resubmit the request. Specify a valid value for the usage limit. Obtain the appropriate permissions and resubmit the request. Submit a valid value. Submit a positive number for the userid. Enter a valid billing code. Submit a valid year between 1900 and the current year. PIPSUGMSFWS

33 User Error Messages Action U1088: The following CSV Column Header Was Not Recognized U1089: The Input CSV File Does Not Contain All Required Column Headers U1090: No Valid CSV Line Entry Was Found U1091: The Request Is Missing The Required Field U1092: The Request Has An Invalid U1093: The Reseller Does Not Do His/Her Own Billing U1094: No Accounts Information Were Found U1095: The Following Field s Length or Format is Invalid U1096: The Submitted Currency is Invalid U1097: Failed to Create All Accounts U1098: The Area Code Submitted is Either Not Valid or Not Allowed For The Reseller U1099: User Sent Null Credentials Name/Password U1100: Failed to Delete All Accounts U1101: An Account Number Must Be a Positive Non-Zero Number uu1102: The Comma Delimited List Contains Invalid Characters or Is Improperly Formatted U1105: You Have Exceeded the Maximum Allowed Items Of TransactionIDListFilter 100. U1105: You Have Exceeded the Maximum Allowed Items Of NumbersListFilter 100. An invalid CSV column header was submitted. The CSV file submitted does not contain all the required column headers. The CSV file submitted did not contain a valid CSV line entry. The request does not contain all required fields. The request contains an invalid address. The indicated reseller does not do his or her own billing. No information could be found for the specified account. The indicated field has the wrong length or format. The currency indicated is not valid. A request to create a group of accounts failed. An invalid area code was submitted. A null value was submitted for either the username or password. A request to delete a group of accounts failed. An invalid account number was submitted. The CSV, comma delimited, list contains invalid characters or improper formatting. The user has sent more than 100 transaction ids. The user has sent more than 100 phone or fax numbers. Enter a valid CSV column header. Update the file to contain all required CSV column headers and resubmit. Update the file to contain at least one valid CSV line entry and resubmit the request. Update the request to contain all the required fields and resubmit the request. Correct the address and resubmit the request. Check the account information and resubmit the request. Correct the field s length or format and resubmit the request. Submit a valid currency. Correct the area code and resubmit the request. Submit a valid value for username and password and resubmit the request. Submit a valid account number. Remove any invalid characters and correct formatting in the CSV list. Use an additional filter or input field to narrow the report results. Use an additional filter or input field to narrow the report results. PIPSUGMSFWS

34 Internal Error Messages Internal Error Messages Action EXXXX: An Internal Error Occurred. An internal error occurred from Protus side Please, notify support and provide the Error Code where XXXX represents the actual number. PIPSUGMSFWS

35 Appendix B Locations of Resources Sending Reporting PIPSUGMSFWS

36 Appendix C Supported File Formats Fax Broadcast supports the following file formats for use as attachments. Adobe PDF AMI Draw Graphics ANSI Text Applix Graphics Applix Spreadsheets Applix Words ASCII Text Computer Graphics Metafile (CGM) Corel Draw CDR (TIFF Header) Corel QuattroPro DCX Encapsulated PostScript (EPS) Enhanced Metafile (EMF) HTML IBM DCA/RFT IBM Displaywrite JPEG File Interchange Format Lotus 1-2-3* Lotus AMI Pro Lotus AMI Professional Write Plus Lotus Freelance* Lotus Pic (PIC) Lotus Word Pro* Mac PICT (raster content) MacPaint (MAC) Maker Interchange Format (MIF) Microsoft Excel Microsoft Excel for Mac Microsoft PowerPoint Microsoft RTF PIPSUGMSFWS

37 Microsoft Windows Bitmap (BMP) Microsoft Windows Write Microsoft Word Microsoft Word for Macintosh Microsoft Works Spreadsheet Microsoft Works PC PaintBrush (PCX) Portable Network Graphics (PNG) SGI RGB Sun Raster TIFF Truevision Targa Unicode Text WordPerfect WordPerfect for Macintosh WordPerfect Graphics (WPG) XyWrite * Supports a restricted set of features PIPSUGMSFWS