Bulk number reserve
Add a multiple numbers to your account and request their provisioning.
Request
Endpoint: | /api/numbers/reserve |
Method: | POST |
Headers: | Accept: application/vnd.cloudlx.v1+json |
Content-type: application/json | |
Authorization: Bearer <access_token> |
Example JSON Request:
{
"number_uuids": [
"7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f",
"f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7"
],
"activate_on": "2014-01-01",
"sbc_trunk_directory_table_id": [4, 74],
"number_translations": [
{
"number_uuid": "7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f",
"all": "442034444444",
},
{
"number_uuid": "f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7",
"all": "442035555555",
}
],
"number_addresses": [
{
"number_uuid": "7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f",
"address_id": 8,
},
{
"number_uuid": "f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7",
"address_id": 7,
}
]
}
Parameters
number_uuids | Description | List of number uuids which reference numbers you want to reserve to your account. |
Type | Array[] | |
Example |
|
|
activate_on | Description | A well formatted date string indicated the day on which the number should be activated. |
Type | String | |
Example | 2014-01-01 | |
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_translations | 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 | Array[Object] | |
Required | No | |
Example |
Toll Free:
[ { "number_uuid": "7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f", "fixed": "80011111111", "mobile": "80011111112", "payphone": "80011111113" }, { "number_uuid": "f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7", "fixed": "80022211111", "mobile": "80022211112", "payphone": "80022211113" }, ]Any other number type: [ { "number_uuid": "7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f", "all": "442034444444", }, { "number_uuid": "f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7", "all": "442035555555", }, ] |
|
number_addresses | Description | An array of objects indicating the relation between numbers and proof of address for numbers in rnages which require or recommend proof of address. |
Type | Array[Object] | |
Required | No | |
Example |
Toll Free:
[ { "number_uuid": "7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f", "number_address_id": 8 }, { "number_uuid": "f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7", "number_address_id": 7 }, ]Any other number type: [ { "number_uuid": "7c327e0f-6bce-4b2f-9d5d-9c86e7fa065f", "all": "442034444444", }, { "number_uuid": "f560af7e68c9-d5d9-f2b4-ecb6-f0e723c7", "all": "442035555555", }, ] |
Response
{
"result": "Numbers allocated to account successfully"
}
result | Description | The result of the request |
Type | String | |
Example | Numbers allocated to account successfully |