masstack

V0
V1
API Overview Resources Schemas

Device Swap

API operation of device API.

Parameters

Name In Type Required Description
org_id path string true ‘none’
body body DeviceSwapCreateDeviceSwapDate true Create a device swap date request for a phone number.

Request body - instance of DeviceSwapCreateDeviceSwapDate

1
2
3

{
  "phoneNumber": "+34666111333"
}
Name Type Required Description
phoneNumber DeviceSwapPhoneNumber false 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 ‘+’.

Request example

1
2
3
4
5
6
7
8


curl -X POST https://opengateway.masstack.com/v0/orgs/{org_id}/device-swap/retrieve-date \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '+34666111333'
}"

Responses

Code Meaning Description Schema
200 OK Contains information about Device swap change DeviceSwapDeviceSwapInfo
400 Bad Request Bad Request DeviceSwapErrorInfo
401 Unauthorized Unauthorized DeviceSwapErrorInfo
403 Forbidden Forbidden

In addition to regular scenario of PERMISSION_DENIED, other scenarios may exist:

Parameters

Name In Type Required Description
org_id path string true ‘none’
body body DeviceSwapCreateCheckDeviceSwap true Create a check device swap request for a phone number.

Request body - instance of DeviceSwapCreateCheckDeviceSwap

1
2
3
4

{
  "phoneNumber": "+34666111333",
  "maxAge": 240
}
Name Type Required Description
phoneNumber DeviceSwapPhoneNumber true 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 ‘+’.
maxAge integer(int32) true Period in hours to be checked for device swap.

Request example

1
2
3
4
5
6
7
8
9


curl -X POST https://opengateway.masstack.com/v0/orgs/{org_id}/device-swap/check \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '+34666111333',
  'maxAge': 240
}"

Responses

Code Meaning Description Schema
200 OK Returns whether a device swap has been performed during a past period DeviceSwapCheckDeviceSwapInfo
400 Bad Request Bad Request

In addition to regular scenario of INVALID_ARGUMENT, other scenarios may exist:

  • Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested (“code”: “OUT_OF_RANGE”,“message”: “Client specified an invalid range.")|DeviceSwapErrorInfo|
    |401|Unauthorized|Unauthorized|DeviceSwapErrorInfo|
    |403|Forbidden|Forbidden

In addition to regular scenario of PERMISSION_DENIED, other scenarios may exist:

Endpoints

Device Swap

    KycMatch