SPS - Subscription Device Management
Documentation Powered by Redocly

SPS - Subscription Device Management (v5)

Download OpenAPI specification:Download

The "Subscription Device Management" API provides the ability to change device/sim/device+sim/device+eSIM, device compatibility and query device details.

Operations

Provides capability to provide compatible networks, block status and device information based on TAC or PEI/IMEI

This method retrieves device information and network capability details based on the PEI (aka IMEI) or TAC code of the device

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Ways to invoke API:

  • Check Compatibility with PEI or IMEI: /compatibility?pei={PEI/IMEI}
  • Check Compatibility with TAC: /compatibility?tac={TAC}

query Parameters
pei
string (pei) [ 15 .. 17 ] characters ^[0-9]{15,17}$
Example: pei=2288151828896431

PEI or IMEI of Device

tac
string (tac) [ 8 .. 16 ] characters ^[0-9]{8,16}$
Example: tac=35646252

Type allocation Code of Device

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json
{
  • "manufacturer": {
    },
  • "equipmentType": "PHONE",
  • "networkCompatibilityList": [
    ],
  • "blockStatus": {
    }
}

Provides the ability to change or swap device/sim/device+sim/device+eSIM of an active subscription

This API provides the ability to swap/change device/sim/device+sim/device+eSIM of an active subscription

Prerequisites:

  1. Check the subscription status
  2. Check Device compatibility if Device change is required
  3. Check SIM availability if SIM change is required

Supported Scenarios:

  1. Change Device Only
  2. Change Physical SIM Only
  3. Change Device and Physical SIM
  4. Change Device and eSIM
  5. Change Device and eSIM with eSIM Delivery Method
  6. Change BYO Device and eSIM
  7. Change BYO Device and eSIM with eSIM Delivery Method

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Note: For BYOD scenario, EID is required

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Change Device and/or SIM

partnerTransactionId
required
string (PartnerTransactionId) [ 1 .. 36 ] characters ^.*$

Transaction identifier/order identifier of Wholesale API consumer/partner

gpsi
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN to be ported-in

iccid
string (iccid) [ 19 .. 20 ] characters ^[0-9]{19,20}$

ICCID or SIM identifier

newPei
string (pei) [ 15 .. 17 ] characters ^[0-9]{15,17}$

PEI or IMEI of Device

changeType
required
string (ChangeType)
Enum: "DeviceOnly" "PSIMOnly" "DeviceAndPSIM" "DeviceAndeSIM"

Change Type DeviceOnly/PSIMOnly/DeviceAndPSIM/DeviceAndeSIM

newIccid
string (iccid) [ 19 .. 20 ] characters ^[0-9]{19,20}$

ICCID or SIM identifier

eSimDeliveryMethod
string (eSIMDeliveryMethod)
Value: "QR"

eSim Delivery Method

newEid
string (eid) [ 19 .. 32 ] characters ^[0-9]{19,32}$

EID of ESIM

Responses

Request samples

Content type
application/json
Example
Change Device Only Request with GPSI
Change Device Only Request with GPSI
Change Device Only Request with ICCID
Change Physical SIM Only Request With GPSI
Change Physical SIM Only Request With ICCID
Change Device and Physical SIM Request With GPSI
Change Device and Physical SIM Request With ICCID
Change Device with eSIM Request With GPSI
Change Device with eSIM Request With ICCID
Change Device with eSIM and eSIM Delivery Method Request With GPSI
Change Device with eSIM and eSIM Delivery Method Request With ICCID
Change BYO Device with eSIM and eSIM Delivery Method Request With GPSI
Change BYO Device with eSIM and eSIM Delivery Method Request With ICCID
{
  • "changeType": "DeviceOnly",
  • "partnerTransactionId": "WhlSlOrd12345",
  • "gpsi": "19459986891",
  • "newPei": "2288151822896431"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Provides the ability to get Device details for the given subscription

This API provides the ability to get Device details for the given subscription

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Ways to invoke API:

  • Get Device Info using iccid: /deviceDetails?pei=11986621644523024501
  • Get Device Info using gpsi: /deviceDetails?gpsi=13035551111

query Parameters
pei
string (pei) [ 15 .. 17 ] characters ^[0-9]{15,17}$
Example: pei=2288151828896431

PEI or IMEI of Device

gpsi
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$
Example: gpsi=2812368903

GPSI/MSISDN

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json
{
  • "deviceStatus": "Active",
  • "isBlocked": true,
  • "gpsi": "2812368903",
  • "supi": "1234567890",
  • "iccid": "11986621644523024501",
  • "pei": "2288151828896431",
  • "eid": "72568199123456782654456783768376",
  • "subscriberId": "SUB3742259805"
}

Provides the ability to query Blocklist Indicator for the given IMEI/PEI

This API provides the ability to query Blocklist Indicator of the device

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Ways to invoke API:

  • Query Blocklist Device using IMEI or PEI: /blockListIndicator?pei=11986621644523024501

query Parameters
pei
required
string (pei) [ 15 .. 17 ] characters ^[0-9]{15,17}$
Example: pei=2288151828896431

PEI or IMEI of Device

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json
{
  • "blockListIndicator": true
}

Provides the ability to add a device to blocklist or remove a device from blocklist

This API provides the ability to add/remove device to/from Blocklist

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Blocklist Device

partnerTransactionId
required
string (PartnerTransactionId) [ 1 .. 36 ] characters ^.*$

Transaction identifier/order identifier of Wholesale API consumer/partner

gpsi
required
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN to be ported-in

pei
required
string (pei) [ 15 .. 17 ] characters ^[0-9]{15,17}$

PEI or IMEI of Device

action
required
string
Enum: "Add" "Remove"

Action Add/Remove

Responses

Request samples

Content type
application/json
Example
Block List Add
Block List Add
Block List Remove
{
  • "partnerTransactionId": "WhlSlOrd12345",
  • "gpsi": "19459986891",
  • "pei": "2288151828896431",
  • "action": "Add"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}