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	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

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.
local_prefix	string	Yes	Yes	The local_prefix field.
area_name	string	Yes	Yes	The area_name field (for example London).
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”, “voice_out”, “t38”, “sms”, “sms_out”. example: “voice,sms”
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.

Sorting:

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

Examples

Simple requestFilter by country.id, did_group_type.id - Include sku_idFilter by city.id, prefix - Include sku_id

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"
                }
            }
        },
        "meta": {
            "available_dids_enabled": false,
            "needs_registration": true,
            "is_available": true,
            "total_count": 21,
            "restrictions": "German Local DID registration requirements:\r\n1. Name, business name and contact phone number.\r\n2. Passport or ID copy.*\r\n3. Current address in Germany, must be from the same city in Germany as the DID ordered (street, building number, postal code, city).\r\n4. Proof of address form (a copy of utility bill no older than of 6 months).\r\n5. Specific registration form is provided during registration process which has to be filled in and signed by the customer.\r\n\r\n*  Number provided online is demo. Active number will be provided when registration process is complete.\r\n** In case registration process is performed under a company name, German company registration certificate shall be provided instead of passport or ID copy.\r\n\r\nInformation should be sent to customer.care@didww.com within 10 days.\r\n\r\nDID number will not be activated until full registration details are provided and approved.\r\n\r\nPlease download and fill in the required form by clicking the following link:\r\nhttps://www.didww.com/docs/Germany_Registration_Form.pdf"
        }

    }],
    "meta": {
        "total_records": 1,
        "api_version": "2017-09-18"
    },
    "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