Get last device swap date

client.deviceswap.retrieveDate(, ?): DeviceswapRetrieveDateResponse { latestDeviceChange, monitoredPeriod }

POST/deviceswap/retrieve-date

Get timestamp of last device swap for a mobile user account provided with phone number.

ParametersExpand Collapse

params: DeviceswapRetrieveDateParams { phoneNumber, xCorrelator }

phoneNumber?: string

Body param: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.

xCorrelator?: string

Header param: Correlation id for the different services

ReturnsExpand 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.

Get last device swap date

import Camara from 'camara-sdk';

const client = new Camara({
  bearerToken: process.env['CAMARA_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.deviceswap.retrieveDate();

console.log(response.latestDeviceChange);

{
  "latestDeviceChange": "2024-09-18T07:37:53.471829447Z"
}

{
  "latestDeviceChange": null,
  "monitoredPeriod": 120
}

{
  "latestDeviceChange": null
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "The specified resource is not found."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "Device identifier not found."
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not available for the provided identifier."
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "The device cannot be identified."
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "The device is already identified by the access token."
}

Returns Examples

{
  "latestDeviceChange": "2024-09-18T07:37:53.471829447Z"
}

{
  "latestDeviceChange": null,
  "monitoredPeriod": 120
}

{
  "latestDeviceChange": null
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "The specified resource is not found."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "Device identifier not found."
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not available for the provided identifier."
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "The device cannot be identified."
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "The device is already identified by the access token."
}