Search DID coverage
search_coverageList DID Groups the authenticated customer can purchase, optionally filtered by country, city and/or number type. country_iso is an ISO 3166-1 alpha-2 code (e.g. CA, US, GB); city is a city name in English (fuzzy-matched, so spacing/hyphens are ignored; only local groups have cities); did_group_type is the number type (Local, National, Mobile, Toll-free, Shared Cost, Global). Each DID Group has one or more Stock Keeping Units (SKUs) at different included-channel tiers and prices. For each group returns: sku_id (pass THIS to buy_did — NOT group_id), group_id, DID Group area name, group type, country ISO code, dialing prefix, supported features (voice, voice_out, t38, sms, sms_out, a2p, p2p, emergency, cnam_out), needs_registration (true = the group requires address registration), restrictions (the group's service-restrictions text, when any — buying a DID from the group means accepting them), available quantity, back_orderable (present and true when the group is API-connected: buy_did purchases it even at 0 available quantity — back-ordering is on by default, see its allow_back_ordering argument — and the numbers are provisioned after the order), and per SKU: setup/monthly price with its currency (all amounts are in USD), included channels with a human label ("2 channels included" / "no channels (metered)") and billing_type (bundled = channels included, metered = 0 channels, pay-per-minute until capacity is attached). Filter by features to keep only groups supporting ALL listed features (e.g. ["sms"] for SMS-capable numbers, ["emergency"] for emergency-calling support).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| npa | No | NANPA area code (3 digits). Narrows the selection to a specific area code — mainly for countries with structured numbering plans, such as the United States and Canada. Combine with nxx for an exact NPA-NXX prefix. | |
| nxx | No | NANPA exchange code (3 digits) — requires npa; narrows the selection to the exact NPA-NXX number prefix. | |
| city | No | City name in English (DIDWW stores city names in English). Fuzzy-matched — "Los Angeles", "Los-Angeles" and "los angeles" all match. Only local groups have cities — do NOT put a number type (e.g. "Mobile") here; use did_group_type. | |
| page | No | Page number (default 1). | |
| region | No | State / administrative region name in English (case-insensitive substring), e.g. "California". Narrows the selection within countries that have sub-national divisions, such as the United States, Canada and the United Kingdom. | |
| features | No | Keep only groups supporting ALL listed features: voice = inbound calls, voice_out = outbound calls, t38 = fax, sms = inbound SMS, sms_out = outbound SMS, a2p/p2p = outbound SMS kinds, emergency = emergency calling (e.g. 911/112), cnam_out = outbound caller-name delivery. | |
| area_name | No | Finds groups for a specific area or locality by name fragment (case-insensitive). The area name is the group's label: a city or locality for geographic groups, or a service area like "Toll-free", "Mobile", "National", "Shared Cost" or "Global" for non-geographic ones (use did_group_type to filter by number type instead). | |
| page_size | No | Results per page (default 50, max 200). | |
| country_iso | No | ISO 3166-1 alpha-2 country code, e.g. CA, US, GB (case-insensitive). | |
| is_available | No | Filter by immediate purchasability: true = only groups you can buy right now (free DIDs in stock OR API-connected back-orderable groups); false = only groups with neither. Omit to list both. | |
| did_group_type | No | Filter by number type. | |
| prefix_contains | No | Finds DID groups matching the entered number prefix — a digit fragment of the full international prefix (country code + area code), e.g. "1212" for US +1 212 groups. | |
| needs_registration | No | Filter by whether the DID Group requires address registration: false = no registration needed. |