Qodex.ai

Get DID Groups

GET https://{{host}}/v3/did_groups?include=stock_keeping_units&filter[nanpa_prefix.id]={{nanpa_prefix.id}}

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 Params

KeyDatatypeRequiredDescription
includestringComma-separated values of include parameter.
The response will include a top-level object relationships with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

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 Object *** | | filter[id] | null | | string - Filters by group id field.

  • Allow blank - No.

  • Allow array - Yes. | | filter[prefix] | null | | string - Filters by the city prefix field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[area_name] | null | | string - Filters by the area_name field (for example London). Case insensitive

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[is_metered] | null | | boolean - Filters by the is_metered field.

  • Allow blank - No.

  • Allow array - No. | | filter[allow_additional_channels] | null | | boolean - Filters by the allow_additional_channels field.

  • Allow blank - No.

  • Allow array - No. | | filter[available_dids_enabled] | null | | boolean - Filters by the available_dids_enabled field.

  • Allow blank - No.

  • Allow array - No. | | filter[features] | null | | string - Filters by the features field.
    Can be one/several/all of voice_in, voice_out, t38, sms_in, sms_out (example: “voice_in,sms_in”).

  • Allow blank - No.

  • Allow array - Yes. | | filter[needs_registration] | null | | boolean - Filters by the needs_registration field.

  • Allow blank - No.

  • Allow array - No. | | filter[is_available] | null | | boolean - Filters by the is_available field.

  • Allow blank - No.

  • Allow array - No. | | filter[country.id] | null | | string - Filters by the country.id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[region.id] | null | | string - Filters by the region.id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[city.id] | null | | string - Filters by the city.id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[nanpa_prefix.id] | string | | string - Filters by the nanpa_prefix.id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[nanpa_prefix.npanxx] | null | | string - Filters by the nanpa_prefix.npanxx field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[did_group_type.id] | null | | string - Filters by the did_group_type.id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

country.name - Sort by the country.name field.

did_group_type.name - Sort by the did_group_type.name field.

prefix - City prefix field.

local_prefix - Sort by the local_prefix field.

is_metered - Sort by the is_metered field.

area_name - Sort by the area_name field.

allow_additional_channels - Sort by the allow_additional_channels field. *** |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":[{"id":"fc271bcc-1f9c-4c19-8174-28b7c55a208a","type":"did_groups","attributes":{"prefix":"20","features":["voice_in","voice_out","t38"],"is_metered":false,"area_name":"London","allow_additional_channels":true},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/country","related":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/country"}},"city":{"links":{"self":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/city","related":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/city"}},"did_group_type":{"links":{"self":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/did_group_type","related":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/did_group_type"}},"region":{"links":{"self":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/region","related":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/region"}},"stock_keeping_units":{"links":{"self":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/stock_keeping_units","related":"https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/stock_keeping_units"},"data":[{"type":"stock_keeping_units","id":"0ba87a94-7143-48cb-a0f6-d50a6a0c8cfa"},{"type":"stock_keeping_units","id":"1a86de53-3131-491f-9e4b-3392da45d441"}]}},"meta":{"available_dids_enabled":true,"needs_registration":false,"is_available":true,"total_count":932}}],"included":[{"id":"0ba87a94-7143-48cb-a0f6-d50a6a0c8cfa","type":"stock_keeping_units","attributes":{"setup_price":"0.0","monthly_price":"0.3","channels_included_count":0}},{"id":"1a86de53-3131-491f-9e4b-3392da45d441","type":"stock_keeping_units","attributes":{"setup_price":"0.0","monthly_price":"0.8","channels_included_count":2}}],"meta":{"total_records":1,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/did_groups?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0\u0026filter%5Bprefix%5D=20\u0026include=stock_keeping_units\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/did_groups?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0\u0026filter%5Bprefix%5D=20\u0026include=stock_keeping_units\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}