Version 4.0

HOME

LinkReports APIs

• Search Call Records

  
  
  Description: Returns a paged set of records for the given job sorted as specified and filtered by the search criteria

  Usage:

  GET api/Alerts/Reports/Link/Search/{JobCode}/{RowIndex}/{PageSize}/{SortField}/{SortDir}/{SearchField}/{SearchCriteria}

  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
  SortField	String	FromUri	The field to sort the results by Value Description BeginStamp Time the call started Phone Phone number dialed EntityName Name of the called entity EntityGuid Guid uniquely identifying called entity CallResult result of the call ResponseResult response keyed by the called entity CauseCode Cause code for terminating the call CompletePlayback True if message played in its entirety DetectedAnsweringMachine True if an answering machine was detected PinValidated True if a pin code was validated BridgeResult result of the 2nd leg of the call
  SortDir	String	FromUri	The direction to sort the results Value Description ASC Sort in ascending order DESC Sort in descending order
  SearchField	String	FromUri	The field to search for criteria in Value Description Phone Phone number dialed EntityName Name of the called entity EntityGuid Guid uniquely identifying called entity CallResult result of the call ResponseResult response keyed by the called entity CauseCode Cause code for terminating the call CompletePlayback True if message played in its entirety DetectedAnsweringMachine True if an answering machine was detected PinValidated True if a pin code was validated BridgeResult result of the 2nd leg of the call
  SearchCriteria	String	FromUri	The value to search for in the given field

  Returns:

  Array of LinkCallRecord objects

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: search the records for the voice link alerts sent for job 1546957 to
  	any EntityName that contains the text "Nick".
  	This will retrieve the 1st page of 5 records sorted by BeginStamp
  	in an Ascending direction.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Alerts/Reports/Link/Search/1546957/0/5/BeginStamp/ASC/EntityName/Nick
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <ArrayOfLinkCallRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Voice">
  <LinkCallRecord>
  <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 11:43:38 AM</BeginStamp>
  <CallResult>call_answered</CallResult>
  <CallType>0</CallType>
  <CauseCode>16</CauseCode>
  <CompletePlayback>false</CompletePlayback>
  <ConnectStamp>3/5/2013 11:43:51 AM</ConnectStamp>
  <CustomerCode>200201</CustomerCode>
  <DetectedAnsweringMachine>false</DetectedAnsweringMachine>
  <Digits>8</Digits>
  <EndStamp>3/5/2013 11:44:02 AM</EndStamp>
  <HasFeedback>false</HasFeedback>
  <JobCode>1546957</JobCode>
  <Language>English</Language>
  <ListCode>667987</ListCode>
  <OutboundMinutes>1</OutboundMinutes>
  <Phone>2012361344</Phone>
  <PhoneIndex>0</PhoneIndex>
  <PinValidated>false</PinValidated>
  <ReplayCount>0</ReplayCount>
  <ResponseRequired>false</ResponseRequired>
  <ResponseResult>-1</ResponseResult>
  <RetryCount>0</RetryCount>
  <UserInput/>
  <BridgeMinutes>0</BridgeMinutes>
  <BridgePhone>2012368625</BridgePhone>
  <BridgeResult>call_answered</BridgeResult>
  </LinkCallRecord>
  </ArrayOfLinkCallRecord>