Description

List the inventory of all DIDs in the system, can be filtered by status, country and number_type.

Parameters

status
country
number_type

Request

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

Response

{
  "status": "success",
  "results": [
    {
      "cust_max_channels": 100,
      "notify_client_when_allocate": true,
      "blocksize": null,
      "tertiary_destination": null,
      "carrier_monthly_fee": null,
      "primary_route": "device",
      "primary_destination": "2842980251XlJPbB",
      "monthly_fee": "0.500",
      "line_type": null,
      "id": 5248538101772491,
      "description": null,
      "backup_destination": null,
      "limit_call_length": false,
      "did_alias": null,
      "state": null,
      "number_type": "geographic",
      "enable_ech": false,
      "provider": 3777204457689089,
      "bill_on_allocation": false,
      "port_status": null,
      "customer_plan": 5223032351472319,
      "backup_route": "congestion",
      "status": "allocated",
      "terminated_date": null,
      "rate_center": null,
      "max_call_length": null,
      "date_port_submitted": null,
      "range_holder": null,
      "setup_fee": "0.500",
      "principal_did": null,
      "date_last_updated": null,
      "tenant": 3066934978789185,
      "customer": 5662853492693467,
      "country": "US",
      "tertiary_route": "congestion",
      "did_address": null,
      "did_number": "12125552345",
      "ported_from": null,
      "carrier_setup_fee": null,
      "created_date": "2018-08-31T11:16:21.067526Z"
    }