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.

includes

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

GET /v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd 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 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

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

{
  "data": {
    "id": "dd13cdb2-48ab-4374-94b3-56e162a659cd",
    "type": "did_groups",
    "links": {
      "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd"
    },
    "attributes": {
      "prefix": "77",
      "local_prefix": "",
      "features": [
        "voice",
        "sms"
      ],
      "is_metered": false,
      "area_name": "National",
      "allow_additional_channels": true
    },
    "relationships": {
      "country": {
        "links": {
          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/country",
          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/country"
        }
      },
      "city": {
        "links": {
          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/city",
          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/city"
        }
      },
      "did_group_type": {
        "links": {
          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/did_group_type",
          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/did_group_type"
        }
      },
      "region": {
        "links": {
          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/region",
          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/region"
        }
      },
      "stock_keeping_units": {
        "links": {
          "self": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/stock_keeping_units",
          "related": "https://api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/stock_keeping_units"
        }
      },
      "requirement": {
          "links": {
              "self": "https://sandbox-api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/requirement",
              "related": "https://sandbox-api.didww.com/v3/did_groups/dd13cdb2-48ab-4374-94b3-56e162a659cd/requirement"
          }
      }
    },
    "meta": {
      "needs_registration": false,
      "is_available": true,
      "available_dids_enabled": false,
      "total_count": 109
    }
  },
  "meta": {
      "api_version": "2021-04-19"
  }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized