Get DID Group#

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

No

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

requirement

Requirements Object

Example#

http

1GET /v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1 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/2187c36d-28fb-436f-8861-5a0f5b5a3ee1 -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": "2187c36d-28fb-436f-8861-5a0f5b5a3ee1",
 7        "type": "did_groups",
 8        "attributes": {
 9            "prefix": "241",
10            "features": [
11                "voice_in"
12            ],
13            "is_metered": false,
14            "area_name": "Aachen",
15            "allow_additional_channels": true
16        },
17        "relationships": {
18            "country": {
19                "links": {
20                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/country",
21                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/country"
22                }
23            },
24            "city": {
25                "links": {
26                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/city",
27                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/city"
28                }
29            },
30            "did_group_type": {
31                "links": {
32                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/did_group_type",
33                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/did_group_type"
34                }
35            },
36            "region": {
37                "links": {
38                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/region",
39                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/region"
40                }
41            },
42            "stock_keeping_units": {
43                "links": {
44                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/stock_keeping_units",
45                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/stock_keeping_units"
46                }
47            },
48            "requirement": {
49                "links": {
50                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/requirement",
51                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/requirement"
52                }
53            }
54        },
55        "meta": {
56            "available_dids_enabled": false,
57            "needs_registration": true,
58            "is_available": true,
59            "total_count": 7
60        }
61    },
62    "meta": {
63        "api_version": "2022-05-10"
64    }
65}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized