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

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized