COcommpeak
DID-Numbers

List the customer's active and suspended DID numbers

Returns the customer's DID (inbound phone) numbers that are activated or suspended; numbers that are still being ordered or have been cancelled are not included. Each number contains its country, name, assigned identity and tags, billing details (monthly fee, next billing date, auto-renewal), whether SMS-to-email is available, and where incoming calls are forwarded to — a SIP URI, a SIP account or a PSTN number, with forward_order showing the configured forwarding type.

get/did_numbers

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/did_numbers
  • Auth
    API key in header Authorization

Response

Successful Response

Example response

{
  "did_numbers": [
    {
      "auto_renewal": true,
      "country": "US",
      "forward_order": "sip_uri_pstn",
      "identity": "John Doe",
      "monthly_fee": 5,
      "name": "United States - New York (Geo)",
      "next_billing_date": "2026-06-22",
      "number": "12125551234",
      "sms": false,
      "state": "activated",
      "tags": [
        "demo"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.