Skip to content
camara
Get started
API Reference

Deviceswap

Device Swap

Get last device swap date
client.deviceswap.retrieveDate(DeviceswapRetrieveDateParams { phoneNumber, xCorrelator } params, RequestOptionsoptions?): DeviceswapRetrieveDateResponse { latestDeviceChange, monitoredPeriod }
POST/deviceswap/retrieve-date
Check last device swap date
client.deviceswap.check(DeviceswapCheckParams { maxAge, phoneNumber, xCorrelator } params, RequestOptionsoptions?): DeviceswapCheckResponse { swapped }
POST/deviceswap/check
ModelsExpand Collapse
DeviceswapRetrieveDateResponse { latestDeviceChange, monitoredPeriod }
latestDeviceChange: string | null

Timestamp of latest device swap performed. It must follow RFC 3339 and must have time zone.

formatdate-time
monitoredPeriod?: number

Timeframe in days for device change supervision for the phone number. It could be valued in the response if the latest Device swap occurred before this monitored period.

DeviceswapCheckResponse { swapped }
swapped: boolean

Indicates whether the device has been swapped during the period within the provided age.