SPS - Subscription Number Management
Documentation Powered by Redocly

SPS - Subscription Number Management (v5)

Download OpenAPI specification:Download

The "Subscription Number Management" API provides the ability to change GPSI and change GPSI with a Port-In opertion.

Operations

Provides the ability to change GPSI of an active subscription

This API provides the ability to change GPSI of an active subscription

Prerequisites:

  1. Check the subscription status

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 Change Number

One of
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

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

GPSI/MSISDN to be ported-in

gpsiReservationId
required
string (GpsiReservationId) [ 1 .. 36 ] characters ^.*$

Number selection Transaction id/order identifier, which is submitted to number management system

Responses

Request samples

Content type
application/json
Example
Change to reserved GPSI using Current GPSI
Change to reserved GPSI using Current GPSI
Change to reserved GPSI using Current ICCID
Change to dynamically reserved GPSI using Current GPSI
Change to dynamically reserved GPSI using Current GPSI
{
  • "partnerTransactionId": "WhlSlOrd12345",
  • "gpsi": "19459986891",
  • "newGpsi": "19459986892",
  • "gpsiReservationId": "NumOrd123"
}

Response samples

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

Provides the ability to change GPSI to Port-In GPSI of an active subscription

This API provides the ability to change change GPSI to Port-In GPSI of an active subscription

Prerequisites:

  1. Check the subscription status

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 Change Number with PortIn Number

One of
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

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

GPSI/MSISDN to be ported-in

required
object (PortInfo)

Port-In Information

Responses

Request samples

Content type
application/json
Example
Change to PortIn GPSI using Current GPSI
Change to PortIn GPSI using Current GPSI
Change to PortIn GPSI using Current ICCID
{
  • "partnerTransactionId": "WhlSlOrd12345",
  • "gpsi": "19459986891",
  • "portInGpsi": "19459986892",
  • "portInfo": {
    }
}

Response samples

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