Version 4.0

HOME

HotlineReports APIs

• List Hotline Records

  
  
  Description: Return the call records for the specified hotline

  Usage:

  GET api/Hotlines/Reports/{PhoneNumber}/{BeginDate}/{EndDate}/{RowIndex}/{PageSize}

  Parameter	Type	Source	Description
  PhoneNumber	String	FromUri	The hotline phone number
  BeginDate	String	FromUri	The date to start returning records from
  EndDate	String	FromUri	The last date to return records from
  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 HotlineRecord objects

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: retrieve the records for calls into the hotline (866) 802-0837 sent between 3/1/2013 and 3/31/2013
  	This will retrieve the 1st page of 5 records.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Hotlines/Reports/8668020837/3-1-2013/3-31-2013/1/5
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <ArrayOfHotlineRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
  	xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Hotline">
  <HotlineRecord>
  <BeginStamp>3/20/2013 3:35:17 PM</BeginStamp>
  <CallRecorded>false</CallRecorded>
  <CallResult>hotline_call_no_result</CallResult>
  <CallerAddress1></CallerAddress1>
  <CallerAddress2></CallerAddress2>
  <CallerCity></CallerCity>
  <CallerCounty></CallerCounty>
  <CallerID>2012361344</CallerID>
  <CallerName></CallerName>
  <CallerState></CallerState>
  <CallerType>0</CallerType>
  <CallerTypeDescription>POTS</CallerTypeDescription>
  <CallerZip></CallerZip>
  <CauseCode>0</CauseCode>
  <CompletePlayback>false</CompletePlayback>
  <DialedNumber></DialedNumber>
  <Digits>3658#,4563#,6,895#,10037#</Digits>
  <EndStamp>3/20/2013 3:35:51 PM</EndStamp>
  <EntityGuid>6f6b59de-21b8-4a47-8c9c-bfa44d6d8860</EntityGuid>
  <HasFeedback>false</HasFeedback>
  <HotlineNumber>8668020837</HotlineNumber>
  <JobCode>0</JobCode>
  <Language></Language>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <MenuCode>659377</MenuCode>
  <MenuName>Custom with RPC</MenuName>
  <Minutes>1</Minutes>
  <OutBeginStamp i:nil="true" />
  <PinValidated>false</PinValidated>
  <Replays>0</Replays>
  <ResponseResult>0</ResponseResult>
  <Seconds>34</Seconds>
  <SecondsToAnswer>0</SecondsToAnswer>
  <TerminationDescription>N/A</TerminationDescription>
  <UserInput></UserInput>
  </HotlineRecord>
  </ArrayOfHotlineRecord> 
  

• List Hotline Records

  
  
  Description: Return the call records for the specified hotline

  Usage:

  GET api/Hotlines/Reports/{PhoneNumber}/{BeginDate}/{EndDate}/{RowIndex}/{PageSize}/{SortField}/{SortDir}

  Parameter	Type	Source	Description
  PhoneNumber	String	FromUri	The hotline phone number
  BeginDate	String	FromUri	The date to start returning records from
  EndDate	String	FromUri	The last date to return records from
  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 The timestamp of the start of the call CallerID Phone number of the person who called the hotline DialedNumber The phone number (if any) that hotline dialed out and connected the caller to CallResult The result of the hotline call ResponseResult The digit response (if any) keyed by the caller
  SortDir	String	FromUri	The direction to sort the results Value Description ASC Sort in ascending order DESC Sort in descending order

  Returns:

  Array of HotlineRecord objects

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: retrieve the records for calls into the hotline (866) 802-0837 sent between 3/1/2013 and 3/31/2013
  				sorted by time stamp from newest to oldest.
  	This will retrieve the 1st page of 5 records.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Hotlines/Reports/8668020837/3-1-2013/3-31-2013/1/5/BeginStamp/DESC
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <ArrayOfHotlineRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
  	xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Hotline">
  <HotlineRecord>
  <BeginStamp>3/20/2013 3:35:17 PM</BeginStamp>
  <CallRecorded>false</CallRecorded>
  <CallResult>hotline_call_no_result</CallResult>
  <CallerAddress1></CallerAddress1>
  <CallerAddress2></CallerAddress2>
  <CallerCity></CallerCity>
  <CallerCounty></CallerCounty>
  <CallerID>2012361344</CallerID>
  <CallerName></CallerName>
  <CallerState></CallerState>
  <CallerType>0</CallerType>
  <CallerTypeDescription>POTS</CallerTypeDescription>
  <CallerZip></CallerZip>
  <CauseCode>0</CauseCode>
  <CompletePlayback>false</CompletePlayback>
  <DialedNumber></DialedNumber>
  <Digits>3658#,4563#,6,895#,10037#</Digits>
  <EndStamp>3/20/2013 3:35:51 PM</EndStamp>
  <EntityGuid>6f6b59de-21b8-4a47-8c9c-bfa44d6d8860</EntityGuid>
  <HasFeedback>false</HasFeedback>
  <HotlineNumber>8668020837</HotlineNumber>
  <JobCode>0</JobCode>
  <Language></Language>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <MenuCode>659377</MenuCode>
  <MenuName>Custom with RPC</MenuName>
  <Minutes>1</Minutes>
  <OutBeginStamp i:nil="true" />
  <PinValidated>false</PinValidated>
  <Replays>0</Replays>
  <ResponseResult>0</ResponseResult>
  <Seconds>34</Seconds>
  <SecondsToAnswer>0</SecondsToAnswer>
  <TerminationDescription>N/A</TerminationDescription>
  <UserInput></UserInput>
  </HotlineRecord>
  </ArrayOfHotlineRecord> 
  

• Search Hotline Records

  
  
  Description: Searchs through the hotline records for calls meeting the search criteria

  Usage:

  GET api/Hotlines/Reports/Search/{PhoneNumber}/{BeginDate}/{EndDate}/{RowIndex}/{PageSize}/{SortField}/{SortDir}/{SearchField}/{SearchCriteria}

  Parameter	Type	Source	Description
  PhoneNumber	String	FromUri	The hotline phone number
  BeginDate	String	FromUri	The date to start returning records from
  EndDate	String	FromUri	The last date to return records from
  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 The timestamp of the start of the call CallerID Phone number of the person who called the hotline DialedNumber The phone number (if any) that hotline dialed out and connected the caller to CallResult The result of the hotline call ResponseResult The digit response (if any) keyed by the caller
  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 CallerID Phone number of the person who called the hotline DialedNumber The phone number (if any) that hotline dialed out and connected the caller to CallResult The result of the hotline call ResponseResult The digit response (if any) keyed by the caller
  SearchCriteria	String	FromUri	The value to search for in the given field

  Returns:

  Array of HotlineRecord objects

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  //-- Currently no examples for XML --// 
  

• Count Hotline Records

  
  
  Description: Get the total number of hotline records

  Usage:

  GET api/Hotlines/Reports/Count/{PhoneNumber}/{BeginDate}/{EndDate}

  Parameter	Type	Source	Description
  PhoneNumber	String	FromUri	The hotline phone number
  BeginDate	String	FromUri	The date to start returning records from
  EndDate	String	FromUri	The last date to return records from

  Returns:

  Total number of records

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: retrieve the count of records for the calls into the hotline (866) 802-0837 sent between 3/1/2013 and 3/31/2013.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Hotlines/Reports/Count/8668020837/3-1-2013/3-31-2013
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <int>1</int> 
  

• Count Search Results

  
  
  Description: Count Hotline Records Search Results

  Usage:

  GET api/Hotlines/Reports/Search/Count/{PhoneNumber}/{BeginDate}/{EndDate}/{SearchField}/{SearchCriteria}

  Parameter	Type	Source	Description
  PhoneNumber	String	FromUri	The hotline phone number
  BeginDate	String	FromUri	The date to start returning records from
  EndDate	String	FromUri	The last date to return records from
  SearchField	String	FromUri	The field to search for criteria in Value Description CallerID Phone number of the person who called the hotline DialedNumber The phone number (if any) that hotline dialed out and connected the caller to CallResult The result of the hotline call ResponseResult The digit response (if any) keyed by the caller
  SearchCriteria	String	FromUri	The value to search for in the given field

  Returns:

  Total number of records

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: count of search results for the records with phone number 2012361344 for calls into 
  				the hotline (866) 802-0837 sent between 3/1/2013 and 3/31/2013.
  	This will retrieve the 1st page of 5 records.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Hotlines/Reports/Search/8668020837/3-1-2013/3-31-2013/1/5/CallerID/2012361344
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <int>1</int> 
  

• Download Hotline Records

  
  
  Description: Downloads a zipped comma-delimited CSV file of the raw records

  Usage:

  GET api/Hotlines/Reports/Download/{PhoneNumber}/{BeginDate}/{EndDate}

  Parameter	Type	Source	Description
  PhoneNumber	String	FromUri	The hotline phone number
  BeginDate	String	FromUri	The date to start returning records from
  EndDate	String	FromUri	The last date to return records from

  Returns:

  Zipped File Content

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: Initiates a downbload of the raw records for calls into 
  				the hotline (866) 802-0837 sent between 3/1/2013 and 3/31/2013
  				with callerid phone of 2012361344.
  		The records are returned in a zip compressed CSV file.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Hotlines/Reports/Download/8668020837/3-1-2013/3-31-2013
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <!-- return value is a binary file -->