Get DID Groups

Description

Returns a list of DID Groups, which is essentially a list of the current DIDWW coverage. 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
filter[<filter_name>]	string, boolean, Integer	Optional	Filtering
include	string	Optional	Inclusion
sort	string	Optional	Sorting

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

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
id	string	No	Yes	Group id field.
prefix	string	Yes	Yes	The city prefix field.
nanpa_prefix.id	string	Yes	Yes	The nanpa prefix id field.
nanpa_prefix.npanxx	string	Yes	Yes	The nanpa prefix npa / nxx fields.
area_name	string	Yes	Yes	The area_name field (for example London). Case insensitive.
is_metered	boolean	No	No	The is_metered field.
allow_additional_channels	boolean	No	No	The allow_additional_channels field.
available_dids_enabled	boolean	No	No	The available_dids_enabled field.
features	string	No	Yes	The features field. Can be one/several/all of “voice_in”, “voice_out”, “t38”, “sms_in”, “sms_out”. example: “voice_in,sms_in”
needs_registration	boolean	No	No	The needs_registration field.
is_available	boolean	No	No	The is_available field.
country.id	string	Yes	Yes	The country.id field.
region.id	string	Yes	Yes	The region.id field.
city.id	string	Yes	Yes	The city.id field.
did_group_type.id	string	Yes	Yes	The did_group_type.id field.
meta.total_count_gteq	Integer	Yes	No	A filter on the list based on the meta.total_count_gteq field, where gteq stands for greater-equal.

Sorting:

Value	Sorts by:
country.name	The country.name field.
did_group_type.name	The did_group_type.name field.
prefix	City prefix field.
is_metered	The is_metered field.
area_name	The area_name field.
allow_additional_channels	The allow_additional_channels field.

Fielding:

Value	Returns:
prefix	City prefix attribute.
is_metered	The is_metered attribute.
area_name	The area_name attribute.
allow_additional_channels	The allow_additional_channels attribute.

Examples

Simple requestFilter by country.id, did_group_type.id - Include sku_idFilter by city.id, prefix - Include sku_idFilter by nanpa_prefix.idFilter by nanpa_prefix.npanxx

http

GET /v3/did_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

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

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [{
        "id": "ac160b14-e670-490f-b158-d3ba552c623f",
        "type": "did_groups",
        "attributes": {
            "prefix": "241",
            "local_prefix": "",
            "features": [
                "voice",
                "voice_out",
                "t38"
            ],
            "is_metered": false,
            "area_name": "Aachen",
            "allow_additional_channels": true
        },
        "relationships": {
            "country": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/country",
                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/country"
                }
            },
            "city": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/city",
                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/city"
                }
            },
            "did_group_type": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/did_group_type",
                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/did_group_type"
                }
            },
            "region": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/region",
                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/region"
                }
            },
            "stock_keeping_units": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/stock_keeping_units",
                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/stock_keeping_units"
                }
            },
            "requirement": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/requirement",
                    "related": "https://sandbox-api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/requirement"
                }
            }
        },
        "meta": {
            "available_dids_enabled": false,
            "needs_registration": true,
            "is_available": true,
            "total_count": 21
        }

    }],
    "meta": {
        "total_records": 1,
        "api_version": "2022-05-10"
    },
    "links": {
        "first": "https://api.didww.com/v3/did_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/did_groups?page%5Bnumber%5D=32&page%5Bsize%5D=50"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized