Get DID Group#

Description

Returns a single DID Group. DID Groups are phone numbers that share a common city or area code.

Request#

HTTP Method: GET

URI Path: /v3/did_groups/

URI Query Parameters:

Name

Type

Is Required?

Description

id

string

Yes

Unique ID number of a DID Group.

include

string

Optional

Inclusion

Includes:

Value

Description

country

Country Object

region

Region Object

city

City Object

did_group_type

DID Group Type Object

stock_keeping_units

A list of Stock Keeping Unit Objects

Example#

http

1GET /v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd 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/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd -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    "id": "dd13cdb2-48ab-4374-94b3-56e162a659cd",
 7    "type": "did_groups",
 8    "links": {
 9      "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd"
10    },
11    "attributes": {
12      "prefix": "77",
13      "local_prefix": "",
14      "features": [
15        "voice",
16        "sms"
17      ],
18      "is_metered": false,
19      "area_name": "National",
20      "allow_additional_channels": true
21    },
22    "relationships": {
23      "country": {
24        "links": {
25          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/country",
26          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/country"
27        }
28      },
29      "city": {
30        "links": {
31          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/city",
32          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/city"
33        }
34      },
35      "did_group_type": {
36        "links": {
37          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/did_group_type",
38          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/did_group_type"
39        }
40      },
41      "region": {
42        "links": {
43          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/region",
44          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/region"
45        }
46      },
47      "stock_keeping_units": {
48        "links": {
49          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/stock_keeping_units",
50          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/stock_keeping_units"
51        }
52      },
53      "requirement": {
54          "links": {
55              "self": "https://sandbox-api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/requirement",
56              "related": "https://sandbox-api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/requirement"
57          }
58      }
59    },
60    "meta": {
61      "needs_registration": false,
62      "is_available": true,
63      "available_dids_enabled": false,
64      "total_count": 109
65    }
66  },
67  "meta": {
68      "api_version": "2021-04-19"
69  }
70}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized