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

A2PGetSmsHistoryRequest

Props

count

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

deliveryStatus

Copy URL
deliveryStatus: 
number
 | 
undefined

The delivery status ID: QUEUED - 1, DISPATCHED - 2, ABORTED - 3, REJECTED - 4, DELIVERED - 5, FAILED - 6, EXPIRED - 7, UNKNOWN - 8

destinationNumber

Copy URL
destinationNumber: 
string
 | 
undefined

The destination phone number

fromDate

Copy URL
fromDate: 
Date

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

offset

Copy URL
offset: 
number
 | 
undefined

The first N records are skipped in the output

output

Copy URL
output: 
string
 | 
undefined

The output format. The possible values are json, csv

sourceNumber

Copy URL
sourceNumber: 
string
 | 
undefined

The source phone number

toDate

Copy URL
toDate: 
Date

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