Reserve a number to your account

Add a number to your account and request it's provisioning.

Request

Endpoint: /api/number/{number_uuid}/reserve
Example: /api/number/7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f/reserve
Method: PUT
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Example JSON Request:

                                
{
    "sbc_trunk_directory_table_id": [4],
    "fixed": "80011111111",
    "mobile": "80011111112",
    "payphone": "80011111113",
    "number_address_id": 8,
    "emergency_number_address_id": 8
}
                                
                            

Optional Parameters

sbc_trunk_directory_table_id Description A list of ID's referring the delivery directory table for call traffic. The list order is the fail-over order, starting with the primary delivery directory table. If this parameter is omitted the number will be activated on all of your delivery tables (this is useful if you only have one delivery table).

A list of your delivery directory tables and their locations can be obtained via the Directory Table API.
Type Array[Integer]
Required No
Example [4, 74]
number_translation Description An array of objects indicating translation numbers.
For Toll Free numbers provide any of fixed, mobile or payphone. For any other type, provide all. To block routing from any network type, provide the value as null.
Type Object
Required No
Example Toll Free:
{
    "fixed": "80011111111",
    "mobile": "80011111112",
    "payphone": "80011111113"
}
Any other number type:
{
    "all": "44203555555"
}
number_address_id Description ID representing the Proof of Address being used to register the number. Number addresses can be found using the Number Addresses API.
Type Integer
Required No
Example 8
emergency_number_address_id Description ID representing the address provided to Emergency Services for this number CLI. Number addresses can be found using the Number Addresses API.
Type Integer
Required No
Example 8

Response

                                
    {
        "result": "Number allocated to account successfully"
    }
                                
                            
result Description The result of the request
Type String
Example Number allocated to account successfully

Back to top