Rate this page:

GetSmsHistoryRequest

Props

count
Optional
Copy URL
count: 

number

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

destinationNumber
Optional
Copy URL
destinationNumber: 

string

The destination phone number

direction
Optional
Copy URL
direction: 

string

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

messageId
Optional
Copy URL
messageId: 

number

|

number[]

|

any

Message id list separated by semicolons (;)

offset
Optional
Copy URL
offset: 

number

The first N records are skipped in the output

output
Optional
Copy URL
output: 

string

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

sourceNumber
Optional
Copy URL
sourceNumber: 

string

The source phone number

timezone
Optional
Copy URL
timezone: 

string

toDate
Optional
Copy URL
toDate: 

Date

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

Rate this page: