VoiceReports APIs
-
List Call Records
Description: Returns a paged set of records for the given jobUsage:
GET api/Alerts/Reports/Voice/{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 voice alerts sent for job 1546897. This will retrieve the 1st page of 5 records. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Voice/1546897/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>14 industrial ave</Address1> <City>Mahwah</City> <County/> <EntityGuid>fff8b034-1e34-43eb-878e-3c237555005c</EntityGuid> <EntityName>Nick</EntityName> <Latitude>0</Latitude> <Longitude>0</Longitude> <PostalCode>07430</PostalCode> <StateProv>NJ</StateProv> <BeginStamp>3/5/2013 10:51:09 AM</BeginStamp> <CallResult>call_error</CallResult> <CallType>0</CallType> <CauseCode>34</CauseCode> <CompletePlayback>false</CompletePlayback> <ConnectStamp/> <CustomerCode>200201</CustomerCode> <DetectedAnsweringMachine>false</DetectedAnsweringMachine> <Digits/> <EndStamp>3/5/2013 10:51:10 AM</EndStamp> <HasFeedback>false</HasFeedback> <JobCode>1546897</JobCode> <Language>English</Language> <ListCode>667987</ListCode> <OutboundMinutes>0</OutboundMinutes> <Phone>2012368625</Phone> <PhoneIndex>0</PhoneIndex> <PinValidated>false</PinValidated> <ReplayCount>0</ReplayCount> <ResponseRequired>true</ResponseRequired> <ResponseResult>-1</ResponseResult> <RetryCount>0</RetryCount> <UserInput/> </CallRecord> <CallRecord> <Address1>14 industrial ave</Address1> <City>Mahwah</City> <County/> <EntityGuid>fff8b034-1e34-43eb-878e-3c237555005c</EntityGuid> <EntityName>Nick</EntityName> <Latitude>0</Latitude> <Longitude>0</Longitude> <PostalCode>07430</PostalCode> <StateProv>NJ</StateProv> <BeginStamp>3/5/2013 10:51:11 AM</BeginStamp> <CallResult>call_answered</CallResult> <CallType>0</CallType> <CauseCode>0</CauseCode> <CompletePlayback>true</CompletePlayback> <ConnectStamp>3/5/2013 10:51:12 AM</ConnectStamp> <CustomerCode>200201</CustomerCode> <DetectedAnsweringMachine>true</DetectedAnsweringMachine> <Digits/> <EndStamp>3/5/2013 10:51:23 AM</EndStamp> <HasFeedback>false</HasFeedback> <JobCode>1546897</JobCode> <Language>English</Language> <ListCode>667987</ListCode> <OutboundMinutes>1</OutboundMinutes> <Phone>2012361344</Phone> <PhoneIndex>1</PhoneIndex> <PinValidated>false</PinValidated> <ReplayCount>1</ReplayCount> <ResponseRequired>true</ResponseRequired> <ResponseResult>-1</ResponseResult> <RetryCount>0</RetryCount> <UserInput/> </CallRecord> </ArrayOfCallRecord>