Request
Endpoint:
|
/api/number-porting-requests
|
Method:
|
POST
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
Authorization: Bearer <access_token>
|
JSON Request
{
"name": "My Porting Request",
"country": "GB",
"number_service_type": "GEOGRAPHIC",
"numbers":[
{
"number": "+442031234567",
"operator": "BT"
},
{
"number": "+442031234567",
"operator": "BT",
"range_holder": "BT",
"account_number": "12345",
"channel": 10
}
]
}
JSON Parameters
name
|
Description
|
A friendly name for the porting request
|
Type
|
String
|
Example
|
My Porting Request
|
country
|
Description
|
The ISO country code for the porting request
|
Type
|
String
|
Example
|
GB
|
number_service_type
|
Description
|
The code representing the Number Service Type. Permitted values; GEOGRAPHIC, TOLL FREE, PREMIUM, MOBILE
|
Type
|
String
|
Example
|
GEOGRAPHIC
|
numbers
|
Description
|
Array of objects describing the numbers to port
|
Type
|
Array[Objects]
|
Example
|
{
"number": "+442031234567",
"operator": "BT",
"range_holder": "BT",
"account_number": "12345",
"channel": 10
}
|
numbers Parameters
number
|
Description
|
The number which is to be ported. This should be in e164 format including the + symbol at the start of the number.
|
Type
|
String
|
Example
|
"+442031234567"
|
country
|
Description
|
The ISO2 code for the country to which the number belongs. A list of ISO codes can be found using the Countries API Endpoint.
|
Type
|
String
|
Example
|
"GB"
|
operator
|
Description
|
The name of the current operator of the number.
|
Type
|
String
|
Example
|
"British Telecommunications PLC"
|
range_holder
|
Description
|
The name of the range holder for the number.
|
Type
|
String
|
Example
|
"British Telecommunications PLC"
|
account_number
|
Description
|
The account number with the losing provider for the number
|
Type
|
String
|
Example
|
"123123123"
|
channel
|
Description
|
The channel information for the number
|
Type
|
String
|
Example
|
"4"
|
Response
Example:
{
"message": "Number Porting Requested created successfully",
"number_count": 4,
"number_port_request_id": 10
}
message
|
Description
|
A human-readable message of the status.
|
Type
|
String
|
Example
|
"Number Porting Requested created successfully"
|
number_count
|
Description
|
The number of numbers which were included on the porting request.
|
Type
|
Integer
|
Example
|
4
|