Description

Allows us to add a single DID or a range of DIDs. For example 12125550000-03

If you are just adding the DIDs in the System and not actually assigning them to a customer you can use the following parameters. If you wish to assign a DID to users then use the did_update API.

Parameters

did_number
did_range_start
did_range_ending
tenant
status
country
number_type

Request

To add a single DID

curl -X POST \-H "Authorization: Token d37fa8c4e008fec158070b1b4aea5f0db3d6a06e" \
-H "Content-Type: application/json" \
-d '{
"did_number":"12125550099",
"tenant": "your.domain.com",
"status":"available",
"country":"US",
"number_type":"geographic"
}' -k https://your.domain.com/api/users/did_add

Response

{
  "status": "success",
  "results": [
    {
      "cust_max_channels": null,
      "blocksize": null,
      "primary_route": "congestion",
      "primary_destination": null,
      "monthly_fee": null,
      "line_type": null,
      "id": 95,
      "backup_destination": null,
      "limit_call_length": false,
      "client_account_code": "",
      "number_type": "geographic",
      "enable_ech": false,
      "bill_on_allocation": false,
      "port_status": null,
      "did_rate_plan": null,
      "backup_route": "congestion",
      "status": "available",
      "date_last_updated": null,
      "description": null,
      "max_call_length": null,
      "date_port_submitted": null,
      "range_holder": null,
      "setup_fee": null,
      "tenant": "your.domain.com",
      "country": "US",
      "ported_from": null,
      "provider_account_code": "",
      "did_number": "12125560099",
      "did_address": null
    },

Request


To Add a Range of DID's

curl -X POST \-H "Authorization: Token d37fa8c4e008fec158070b1b4aea5f0db3d6a06e" \
-H "Content-Type: application/json" \
-d '{
"did_range_start":12125550000,
"did_range_end":12125550003,
"tenant": "your.domain.com",
"status":"available",
"country":"US",
"number_type":"geographic"
}' -k https://your.domain.com/api/users/did_add

`Response`

{
  "status": "success",
  "results": [
    {
      "cust_max_channels": null,
      "blocksize": null,
      "primary_route": "congestion",
      "primary_destination": null,
      "monthly_fee": null,
      "line_type": null,
      "id": 99,
      "backup_destination": null,
      "limit_call_length": false,
      "client_account_code": "",
      "number_type": "geographic",
      "enable_ech": false,
      "bill_on_allocation": false,
      "port_status": null,
      "did_rate_plan": null,
      "backup_route": "congestion",
      "status": "available",
      "date_last_updated": null,
      "description": null,
      "max_call_length": null,
      "date_port_submitted": null,
      "range_holder": null,
      "setup_fee": null,
      "tenant": "your.domain.com",
      "country": "US",
      "ported_from": null,
      "provider_account_code": "",
      "did_number": "12125560000",
      "did_address": null
    },
    {
      "cust_max_channels": null,
      "blocksize": null,
      "primary_route": "congestion",
      "primary_destination": null,
      "monthly_fee": null,
      "line_type": null,
      "id": 100,
      "backup_destination": null,
      "limit_call_length": false,
      "client_account_code": "",
      "number_type": "geographic",
      "enable_ech": false,
      "bill_on_allocation": false,
      "port_status": null,
      "customer_plan": null,
      "backup_route": "congestion",
      "status": "available",
      "date_last_updated": null,
      "description": null,
      "max_call_length": null,
      "date_port_submitted": null,
      "range_holder": null,
      "setup_fee": null,
      "tenant": "your.domain.com",
      "country": "US",
      "ported_from": null,
      "provider_account_code": "",
      "did_number": "12125560001",
      "did_address": null
    },
    {
      "cust_max_channels": null,
      "blocksize": null,
      "primary_route": "congestion",
      "primary_destination": null,
      "monthly_fee": null,
      "line_type": null,
      "id": 101,
      "backup_destination": null,
      "limit_call_length": false,
      "client_account_code": "",
      "number_type": "geographic",
      "enable_ech": false,
      "bill_on_allocation": false,
      "port_status": null,
      "customer_plan": null,
      "backup_route": "congestion",
      "status": "available",
      "date_last_updated": null,
      "description": null,
      "max_call_length": null,
      "date_port_submitted": null,
      "range_holder": null,
      "setup_fee": null,
      "tenant": "your.domain.com",
      "country": "US",
      "ported_from": null,
      "provider_account_code": "",
      "did_number": "12125560002",
      "did_address": null
    },
    {
      "cust_max_channels": null,
      "blocksize": null,
      "primary_route": "congestion",
      "primary_destination": null,
      "monthly_fee": null,
      "line_type": null,
      "id": 102,
      "backup_destination": null,
      "limit_call_length": false,
      "client_account_code": "",
      "number_type": "geographic",
      "enable_ech": false,
      "bill_on_allocation": false,
      "port_status": null,
      "customer_plan": null,
      "backup_route": "congestion",
      "status": "available",
      "date_last_updated": null,
      "description": null,
      "max_call_length": null,
      "date_port_submitted": null,
      "range_holder": null,
      "setup_fee": null,
      "tenant": "your.domain.com",
      "country": "US",
      "ported_from": null,
      "provider_account_code": "",
      "did_number": "12125560003",
      "did_address": null
    }
]
}