Get DIDs#

Returns a list of DIDs owned by your account.

Request#

HTTP Method: GET

URI Path: /v3/dids

URI Query Parameters#

Name

Type

Is Required?

Description

filter[<filter_name>]

string, boolean

No

Filtering

include

string

No

Inclusion

sort

string

No

Sorting

Includes#

Value

Description

order

Order Object

voice_in_trunk

Trunk Object

voice_in_trunk.voice_in_trunk_group

Trunk Group Object

voice_in_trunk.pop

POP Object

voice_in_trunk_group

Trunk Group Object

capacity_pool

Capacity Pool Object

shared_capacity_group

Shared Capacity Group Object

did_group

DID Group Object

did_group.country

Country Object

did_group.city

City Object

did_group.region

Region Object

did_group.did_group_type

DID Group Type Object

did_group.stock_keeping_units

Stock Keeping Unit Object

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

number

string

Yes

Yes

The DID number field.

description

string

Yes

Yes

The description field.

terminated

boolean

No

No

The terminated field.

awaiting_registration

boolean

No

No

The awaiting_registration field.

blocked

boolean

No

No

The blocked field.

billing_cycles_count

integer

Yes

No

The billing_cycles_count field.

did_group.id

string

Yes

Yes

The ID field of did_group relationship.

country.id

string

Yes

Yes

The ID field of country relationship.

region.id

string

Yes

Yes

The ID field of region relationship.

city.id

string

Yes

Yes

The ID field of city relationship.

order.id

string

Yes

Yes

The ID field of order relationship.

voice_in_trunk.id

string

Yes

Yes

The ID field of voice_in_trunk relationship.

voice_in_trunk_group.id

string

Yes

Yes

The ID field of voice_in_trunk_group relationship.

shared_capacity_group.id

string

Yes

Yes

The ID field of shared_capacity_group relationship.

capacity_pool.id

string

Yes

Yes

The ID field of capacity_pool relationship.

order.reference

string

No

Yes

The reference field of order relationship.

did_group.features

string

No

Yes

DID Group features field.

address_verification.id

string

Yes

Yes

The ID field of address_verification relationship.

Sorting#

Value

Sorts by:

blocked

Blocked status

awaiting_registration

Awaiting registration status

terminated

Termination status

capacity_limit

Capacity limit

billing_cycles_count

Billing cycles count

description

Description text

number

DID number

expires_at

Expiration timestamp

channels_included_count

Included channels count

dedicated_channels_count

Dedicated channels count

created_at

Creation timestamp

Sparse Fieldsets#

Value

Returns:

blocked

The blocked attribute

awaiting_registration

The awaiting_registration attribute

terminated

The terminated attribute

capacity_limit

The capacity_limit attribute

billing_cycles_count

The billing_cycles_count attribute

description

The description attribute

number

The number attribute

expires_at

The expires_at attribute

channels_included_count

The channels_included_count attribute

dedicated_channels_count

The dedicated_channels_count attribute

created_at

The created_at attribute

Examples#

http

1GET /v3/dids HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/dids -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

  1HTTP/1.1 200 OK
  2Content-Type: application/vnd.api+json
  3
  4  {
  5    "data": [
  6      {
  7        "id": "ac40fb08-ac14-4a6c-8f20-fe650870c266",
  8        "type": "dids",
  9        "attributes": {
 10          "blocked": false,
 11          "capacity_limit": 1,
 12          "description": "string",
 13          "terminated": false,
 14          "awaiting_registration": false,
 15          "number": "437xxxxxxxxx",
 16          "expires_at": "2017-06-25T08:21:41.795Z",
 17          "channels_included_count": 2,
 18          "created_at": "2017-06-25T08:21:41.795Z",
 19          "dedicated_channels_count": 0
 20        },
 21        "relationships": {
 22          "did_group": {
 23            "links": {
 24              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/did_group",
 25              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/did_group"
 26            }
 27          },
 28          "order": {
 29            "links": {
 30              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/order",
 31              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/order"
 32            }
 33          },
 34          "voice_in_trunk": {
 35            "links": {
 36              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk",
 37              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk"
 38            }
 39          },
 40          "voice_in_trunk_group": {
 41            "links": {
 42              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk_group",
 43              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk_group"
 44            }
 45          },
 46          "capacity_pool": {
 47            "links": {
 48              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/capacity_pool",
 49              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/capacity_pool"
 50            }
 51          },
 52          "shared_capacity_group": {
 53            "links": {
 54              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/shared_capacity_group",
 55              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/shared_capacity_group"
 56            }
 57          },
 58          "address_verification": {
 59            "links": {
 60              "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/address_verification",
 61              "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/address_verification"
 62            }
 63          }
 64        }
 65      },
 66      {
 67        "id": "b37f0fcf-24d0-4799-8e81-a69bcc889f2e",
 68        "type": "dids",
 69        "attributes": {
 70          "blocked": false,
 71          "capacity_limit": 1,
 72          "description": "string",
 73          "terminated": false,
 74          "awaiting_registration": false,
 75          "number": "437xxxxxxxxx",
 76          "expires_at": "2017-06-25T08:21:41.795Z",
 77          "channels_included_count": 2,
 78          "created_at": "2017-06-25T08:21:41.795Z",
 79          "dedicated_channels_count": 0
 80        },
 81        "relationships": {
 82          "did_group": {
 83            "links": {
 84              "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/did_group",
 85              "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/did_group"
 86            }
 87          },
 88          "order": {
 89            "links": {
 90              "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/order",
 91              "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/order"
 92            }
 93          },
 94          "voice_in_trunk": {
 95            "links": {
 96              "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/voice_in_trunk",
 97              "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/voice_in_trunk"
 98            }
 99          },
100          "voice_in_trunk_group": {
101            "links": {
102              "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/voice_in_trunk_group",
103              "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/voice_in_trunk_group"
104            }
105          },
106          "capacity_pool": {
107            "links": {
108              "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/capacity_pool",
109              "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/capacity_pool"
110            }
111          },
112          "shared_capacity_group": {
113            "links": {
114              "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/shared_capacity_group",
115              "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/shared_capacity_group"
116            }
117          }
118        }
119      }
120    ],
121    "meta": {
122      "total_records": 2
123    },
124    "links": {
125      "first": "https://api.didww.com/v3/dids&page%5Bnumber%5D=1&page%5Bsize%5D=50",
126      "last": "https://api.didww.com/v3/dids&page%5Bnumber%5D=1&page%5Bsize%5D=50"
127    }
128  }

Other Responses#

Code

Success

Description

401

No

Unauthorized