| Resource | Description |
|---|---|
| Mobile portabilities | Get info about portabilities |
| Mobile operations | Manage portabilities |
| Resource | Description |
|---|---|
| Mobile portabilities | Get info about portabilities |
| Mobile operations | Manage portabilities |
Returns a list of portabilities
PATH PARAMETERS
Tenant
QUERY PARAMETERS
Add filter to get portabilites
OK successful operation
[
{
"access_type": "string",
"cause_status": "string",
"contract_code": "string",
"create_date_nc": "string",
"donor_operator": "string",
"external_reference": "string",
"icc_id": "string",
"id": "string",
"message_type": "string",
"msisdn": "string",
"nrn_receptor": "string",
"process_id": "string",
"recipient_operator": "string",
"recipient_rol": true,
"state": "string",
"tenant": "string",
"window_date": "string"
}
] | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
access_type | string | |||
cause_status | string | |||
contract_code | string | |||
create_date_nc | string | |||
donor_operator | string | |||
external_reference | string | |||
icc_id | string | |||
id | string | |||
message_type | string | |||
msisdn | string | |||
nrn_receptor | string | |||
process_id | string | |||
recipient_operator | string | |||
recipient_rol | boolean | |||
state | string | |||
tenant | string | |||
window_date | string |
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities' \
-H 'Accept: application/json' Returns a list of portabilities filter by processId
PATH PARAMETERS
Tenant
ProcessId
QUERY PARAMETERS
Add filter to get portabilites
OK successful operation
[
{
"access_type": "string",
"cause_status": "string",
"contract_code": "string",
"create_date_nc": "string",
"donor_operator": "string",
"external_reference": "string",
"icc_id": "string",
"id": "string",
"message_type": "string",
"msisdn": "string",
"nrn_receptor": "string",
"process_id": "string",
"recipient_operator": "string",
"recipient_rol": true,
"state": "string",
"tenant": "string",
"window_date": "string"
}
] | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
access_type | string | |||
cause_status | string | |||
contract_code | string | |||
create_date_nc | string | |||
donor_operator | string | |||
external_reference | string | |||
icc_id | string | |||
id | string | |||
message_type | string | |||
msisdn | string | |||
nrn_receptor | string | |||
process_id | string | |||
recipient_operator | string | |||
recipient_rol | boolean | |||
state | string | |||
tenant | string | |||
window_date | string |
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/processId/:processId' \
-H 'Accept: application/json' Returns a list of portabilities filter by msisdn
PATH PARAMETERS
Tenant
Msisdn
QUERY PARAMETERS
Add filter to get portabilites
OK successful operation
[
{
"access_type": "string",
"cause_status": "string",
"contract_code": "string",
"create_date_nc": "string",
"donor_operator": "string",
"external_reference": "string",
"icc_id": "string",
"id": "string",
"message_type": "string",
"msisdn": "string",
"nrn_receptor": "string",
"process_id": "string",
"recipient_operator": "string",
"recipient_rol": true,
"state": "string",
"tenant": "string",
"window_date": "string"
}
] | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
access_type | string | |||
cause_status | string | |||
contract_code | string | |||
create_date_nc | string | |||
donor_operator | string | |||
external_reference | string | |||
icc_id | string | |||
id | string | |||
message_type | string | |||
msisdn | string | |||
nrn_receptor | string | |||
process_id | string | |||
recipient_operator | string | |||
recipient_rol | boolean | |||
state | string | |||
tenant | string | |||
window_date | string |
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/msisdn/:msisdn' \
-H 'Accept: application/json' Returns last portability from a msisdn
PATH PARAMETERS
Tenant
Msisdn
QUERY PARAMETERS
Add filter to get portabilites
OK successful operation
[
{
"access_type": "string",
"cause_status": "string",
"contract_code": "string",
"create_date_nc": "string",
"donor_operator": "string",
"external_reference": "string",
"icc_id": "string",
"id": "string",
"message_type": "string",
"msisdn": "string",
"nrn_receptor": "string",
"process_id": "string",
"recipient_operator": "string",
"recipient_rol": true,
"state": "string",
"tenant": "string",
"window_date": "string"
}
] | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
access_type | string | |||
cause_status | string | |||
contract_code | string | |||
create_date_nc | string | |||
donor_operator | string | |||
external_reference | string | |||
icc_id | string | |||
id | string | |||
message_type | string | |||
msisdn | string | |||
nrn_receptor | string | |||
process_id | string | |||
recipient_operator | string | |||
recipient_rol | boolean | |||
state | string | |||
tenant | string | |||
window_date | string |
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/msisdn/:msisdn/last' \
-H 'Accept: application/json' Returns a portability
PATH PARAMETERS
Tenant
id
OK successful operation
{
"access_type": "string",
"cause_status": "string",
"contract_code": "string",
"create_date_nc": "string",
"donor_operator": "string",
"id": "string",
"message_type": "string",
"msisdn": "string",
"nrn_receptor": "string",
"portability_events": {
"account": {
"cause_status": "string",
"event_date": "string",
"id": "string",
"message_type": "string",
"notification_code": "string",
"process_id": "string",
"recipient_rol": "string"
}
},
"process_id": "string",
"recipient_operator": "string",
"recipient_rol": true,
"state": "string",
"subscriber": {
"account": {
"addresses": [
{
"address": "Calle Leonardo Prieto, 8",
"city": "Madrid",
"country": "Spain",
"postal_code": "28040",
"province": "Madrid",
"type": "CONTACT"
}
],
"document": "09288205T",
"document_type": "NIF",
"id": null,
"email": null,
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"name": "Martina",
"nationality": "España",
"second_name": null,
"surname": "Fraile Méndez"
}
},
"tenant": "string",
"window_date": "string"
} | Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
access_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cause_status | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_code | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
create_date_nc | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_operator | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msisdn | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nrn_receptor | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
portability_events | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
process_id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recipient_operator | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recipient_rol | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriber | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenant | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
window_date | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/id/:id' \
-H 'Accept: application/json' Returns a list of portability pending response
PATH PARAMETERS
Tenant
OK successful operation
[
{
"access_type": "string",
"cause_status": "string",
"contract_code": "string",
"create_date_nc": "string",
"donor_operator": "string",
"external_reference": "string",
"icc_id": "string",
"id": "string",
"message_type": "string",
"msisdn": "string",
"nrn_receptor": "string",
"process_id": "string",
"recipient_operator": "string",
"recipient_rol": true,
"state": "string",
"tenant": "string",
"window_date": "string"
}
] | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
access_type | string | |||
cause_status | string | |||
contract_code | string | |||
create_date_nc | string | |||
donor_operator | string | |||
external_reference | string | |||
icc_id | string | |||
id | string | |||
message_type | string | |||
msisdn | string | |||
nrn_receptor | string | |||
process_id | string | |||
recipient_operator | string | |||
recipient_rol | boolean | |||
state | string | |||
tenant | string | |||
window_date | string |
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/pendingDonor' \
-H 'Accept: application/json' Returns the filtered info saved from operators in Central Node
PATH PARAMETERS
Tenant
QUERY PARAMETERS
Operator
Operator code
Operator status
OK successful operation
[
[
{
"id": 4,
"operator": "YOIGO",
"operator_code": "005",
"nrn_range": [
{
"id": 0,
"initial_nrn": 900053,
"final_nrn": 900056
}
],
"network_operator": "003",
"msisdn_range": [
{
"id": 0,
"initial_msisdn": 600000000,
"final_msisdn": 600000001
}
],
"individual_quota": "A",
"multiple_quota": 50,
"change_quota": 1000,
"status": "ACTIVO",
"status_date": "2024-01-30T10:00:00Z",
"backup": false
}
]
] | Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | integer (int64) | Operator Config id | ||||||||||||||||||||||
operator | string | The operator name | maxLength: 255 | |||||||||||||||||||||
operator_code | string | The operator code | maxLength: 3 | |||||||||||||||||||||
nrn_range | object[] | |||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
network_operator | string | Network operator code | maxLength: 3 | |||||||||||||||||||||
msisdn_range | object[] | |||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
individual_quota | string | Character representing the group of maximum daily individual portability requests the operator belongs to. | maxLength: 1 | |||||||||||||||||||||
multiple_quota | integer | Maximum daily number of multiple portability requests allowed by the operator. | max: 99 | |||||||||||||||||||||
change_quota | integer | Maximum daily number of changes allowed by the operator as donor rol. | max: 999999999 | |||||||||||||||||||||
status | string
()
ACTIVODESHABILITADOALTA_EXTRAORDINARIA | Operator status. Must be in: [ACTIVO,DESHABILITADO,ALTA_EXTRAORDINARIA] | maxLength: 32 | |||||||||||||||||||||
status_date | string (date-time) | Operator status change date | ||||||||||||||||||||||
backup | boolean | Whether the entry is backed up or not. | ||||||||||||||||||||||
Not Found Not Found
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/operator' \
-H 'Accept: application/json' Create portability request
PATH PARAMETERS
Tenant
{
"access_type": "INDIVIDUAL",
"contract_code": "00528902840",
"external_reference": "PORTIN_902840_634443633",
"msisdn_ranges": [
{
"initial_range": {
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"icc_id": "8934221507160508791"
},
"end_range": {
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"icc_id": "8934221507160508791"
}
}
],
"nrn_receptor": "741111",
"recipient_operator": null,
"subscriber": {
"addresses": [
{
"address": "Calle Leonardo Prieto, 8",
"city": "Madrid",
"country": "Spain",
"postal_code": "28040",
"province": "Madrid",
"type": "CONTACT"
}
],
"document": "09288205T",
"document_type": "NIF",
"id": null,
"email": null,
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"name": "Martina",
"nationality": "España",
"second_name": null,
"surname": "Fraile Méndez"
},
"subscriber_request_date": "2022-02-24T13:45:10Z",
"window_date": null
} | Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
access_type* | string
()
INDIVIDUALMULTIPLEMIXED | Access type of the request. Must be one of these values: [INDIVIDUAL,MULTIPLE,MIXED] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contract_code* | string | Contract signed by subscriber | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_reference | string | External identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msisdn_ranges* | object[] | List of phone number ranges to port | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nrn_receptor* | string | Network Routing Number of recipient operator. Must match pattern '^[\\d]{6,6}$' | pattern: ^[\d]{6,6}$ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recipient_operator | string | Receiving operator code. Must match pattern '^[\\d]{3,3}$' | pattern: ^[\d]{3,3}$ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriber | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscriber_request_date | string | Date of the portability request. Timestamp in UTC time zone, format yyyy-MM-ddTHH:mm:ssZ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
window_date | string | Window date of the portability. Timestamp in UTC time zone, format yyyy-MM-ddTHH:mm:ssZ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Created
No Content No Content
Bad Request Bad Request
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X POST 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities' \
-H 'Content-Type: application/json' \
--data-raw '{
"access_type": "INDIVIDUAL",
"contract_code": "00528902840",
"external_reference": "PORTIN_902840_634443633",
"msisdn_ranges": [
{
"initial_range": {
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"icc_id": "8934221507160508791"
},
"end_range": {
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"icc_id": "8934221507160508791"
}
}
],
"nrn_receptor": "741111",
"recipient_operator": null,
"subscriber": {
"addresses": [
{
"address": "Calle Leonardo Prieto, 8",
"city": "Madrid",
"country": "Spain",
"postal_code": "28040",
"province": "Madrid",
"type": "CONTACT"
}
],
"document": "09288205T",
"document_type": "NIF",
"id": null,
"email": null,
"msisdn": {
"country_code": "34",
"number": "634443633"
},
"name": "Martina",
"nationality": "España",
"second_name": null,
"surname": "Fraile Méndez"
},
"subscriber_request_date": "2022-02-24T13:45:10Z",
"window_date": null
}' Accept donor portability
PATH PARAMETERS
Tenant
ProcessId would be accept
Created Created
No Content No Content
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X POST 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/:processId/accept' Deny donor portability
PATH PARAMETERS
Tenant
ProcessId would be deny
{
"cause": "string"
} | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
cause | string |
Created Created
No Content No Content
Bad Request Bad Request
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X POST 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/:processId/deny' \
-H 'Content-Type: application/json' \
--data-raw '{
"cause": "string"
}' Return the operator owner
PATH PARAMETERS
Tenant
Msisdn
OK successful operation
{
"msisdn": "string",
"nrn": "string",
"codigoOperadorActual": "string",
"codigoOperadorPropietarioRango": "string",
"involucradaProcesoPortabilidad": true,
"portada": true,
"codigoReferenciaSolicitudPortabilidadMovil": "string",
"codigoReferenciaIncidencia": [
"string"
]
} | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
msisdn | string | |||
nrn | string | |||
codigoOperadorActual | string | |||
codigoOperadorPropietarioRango | string | |||
involucradaProcesoPortabilidad | boolean | |||
portada | boolean | |||
codigoReferenciaSolicitudPortabilidadMovil | string | |||
codigoReferenciaIncidencia | string[] |
Not Found Not Found
Internal Server Error Internal Server Error
curl -X GET 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/ownerOperator/:msisdn' \
-H 'Accept: application/json' Reset the response of a portability before portability window
PATH PARAMETERS
Tenant
Process id
Created Created
No Content No Content
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X POST 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/:processId/restartReply' Cancel a portability
PATH PARAMETERS
Tenant
Msisdn
{
"cause": "string"
} | Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
cause | string |
Created Created
No Content No Content
Bad Request Bad Request
Unauthorized Unauthorized
Internal Server Error Internal Server Error
curl -X POST 'https://mas-portability.sta.masstack.com/v1/orgs/:orgs/portabilities/:msisdn/cancel' \
-H 'Content-Type: application/json' \
--data-raw '{
"cause": "string"
}'