FaxReports APIs
-
List Fax Records
Description: Returns a paged set of records for the given jobUsage:
GET api/Alerts/Reports/Fax/{JobCode}/{RowIndex}/{PageSize}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for RowIndex Int32 FromUri the starting row index for the page to get records from. The first row starts with 0. PageSize Int32 FromUri the total number of records to return in a page Returns:
Array of CallRecord objects
Examples:
<!-- Intent: retrieve the records for the fax alerts sent for job 1546907. This will retrieve the 1st page of 5 records. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/1546907/0/5 --> <!-- No XML input is required --> <!-- example return value --> <ArrayOfCallRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Voice"> <CallRecord> <Address1/> <City/> <County/> <EntityGuid>cad50a1d-f0bf-45d7-992f-787b22fadf6d</EntityGuid> <EntityName>sample</EntityName> <Latitude>0</Latitude> <Longitude>0</Longitude> <PostalCode/> <StateProv/> <BeginStamp>3/5/2013 11:02:49 AM</BeginStamp> <CallResult>call_answered</CallResult> <CallType>0</CallType> <CauseCode>0</CauseCode> <CompletePlayback>true</CompletePlayback> <ConnectStamp>3/5/2013 11:02:53 AM</ConnectStamp> <CustomerCode>200201</CustomerCode> <DetectedAnsweringMachine>false</DetectedAnsweringMachine> <Digits/> <EndStamp>3/5/2013 11:03:19 AM</EndStamp> <HasFeedback>false</HasFeedback> <JobCode>1546907</JobCode> <Language>English</Language> <ListCode>0</ListCode> <OutboundMinutes>1</OutboundMinutes> <Phone>2012361222</Phone> <PhoneIndex>0</PhoneIndex> <PinValidated>false</PinValidated> <ReplayCount>0</ReplayCount> <ResponseRequired>false</ResponseRequired> <ResponseResult>-1</ResponseResult> <RetryCount>0</RetryCount> <UserInput i:nil="true"/> </CallRecord> </ArrayOfCallRecord>