Version 4.0

HOME

TextReports APIs

• List SMS Records

  
  
  Description: Returns a paged set of records for the given job sorted as specified

  Usage:

  GET api/Alerts/Reports/Text/{JobCode}/{RowIndex}/{PageSize}/{SortField}/{SortDir}

  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 TimeStamp The date and time the message was sent EntityName The name of the recipient entity EntityGuid Guid that uniquely identifies the recipient SMSAddress The phone number the message was sent to SMSResult The result of the message send ReplyText The text of any reply sent in response to the message
  SortDir	String	FromUri	The direction to sort the results Value Description ASC Sort in ascending order DESC Sort in descending order

  Returns:

  Array of SMSRecord objects

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: retrieve the records for the sms alerts sent for job 1541867.
  	This will retrieve the 1st page of 5 records sorted by TimeStamp
  	in an Ascending direction.
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Alerts/Reports/Text/1541867/0/5/TimeStamp/ASC
  	-->
  
  <!-- No XML input is required -->
  
  <!-- example return value -->
  <ArrayOfSMSRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.SMS">
  <SMSRecord>
  <Address1>25 Raven Avenue</Address1>
  <City>Piscataway</City>
  <County>Middlesex</County>
  <CustomerCode>200201</CustomerCode>
  <EntityName>Robert Lindabury</EntityName>
  <JobCode>1541867</JobCode>
  <Language>English</Language>
  <Latitude>40.557746887207031</Latitude>
  <ListCode>668027</ListCode>
  <Longitude>-74.495903179049492</Longitude>
  <PostalCode>08854-3666</PostalCode>
  <ReplyText/>
  <SMSAddress>9087203553</SMSAddress>
  <SMSResult>0</SMSResult>
  <State>New Jersey</State>
  <TimeStamp>12/1/2012 10:54:51 PM</TimeStamp>
  </SMSRecord>
  </ArrayOfSMSRecord>