Create a Porting Request

Create a Porting Request for numbers to be moved to Phonebook from their current provider(s).

Request

Endpoint: /api/number-porting-requests/new
Method: POST
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

JSON Request

                                {
    "porting_numbers": [
        {
            "number": "442031111111",
            "country": "GB",
            "operator": "British Telecommunications PLC",
            "channel": "4"
        }
    ]
}
                            

JSON Parameters

porting_numbers Description Array of objects describing the numbers to port
Type Array[Object]
Example
                                    {
    "number": "442031111111",
    "country": "GB",
    "operator": "British Telecommunications PLC",
    "channel": "4"
}
                                        

porting_numbers Parameters

number Description The number which is to be ported. This should be in e164 format without the + symbol or any other characters apart from digits.
Type String
Example "442031111111"
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"
channel Description The channel information for the number
Type String
Example "4"

Response

Example:

                                
    {
        "message": "Number Porting Requested created successfully",
        "number_count": 4
    }
                                
                            
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

Back to top