1. References
  2. VoxEngine
  3. VoximplantAPI
  4. GetSmsHistoryRequest
Rate this page:

GetSmsHistoryRequest

Props

count

Optional
Copy URL
count: 
number
 | 
undefined

Maximum number of resulting rows fetched. Must be not bigger than 1000. If left blank, then the default value of 1000 is used

destinationNumber

Optional
Copy URL
destinationNumber: 
string
 | 
undefined

The destination phone number

direction

Optional
Copy URL
direction: 
string
 | 
undefined

Sent or received SMS. Possible values: 'IN', 'OUT', 'in, 'out'. Leave blank to get both incoming and outgoing messages

fromDate

Optional
Copy URL
fromDate: 
Date

Date from which to perform search. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC

offset

Optional
Copy URL
offset: 
number
 | 
undefined

The first N records are skipped in the output

output

Optional
Copy URL
output: 
string
 | 
undefined

The output format. The following values available: json, csv, xls. The default value is json

sourceNumber

Optional
Copy URL
sourceNumber: 
string
 | 
undefined

The source phone number

toDate

Optional
Copy URL
toDate: 
Date

Date until which to perform search. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC