COcommpeak
Allowed-Caller-IDs

List verified caller IDs allowed for outbound calls

Returns the customer's verified Caller IDs (CLIs) that may be used for outbound calls. When locked is true, the customer may only call using the listed Caller IDs; when false, any Caller ID is allowed. limitations.capacity maps a Caller ID to its maximum concurrent call capacity and contains only numbers with a capacity limit. caller_ids lists every Caller ID of the account, including those still waiting for verification, with the id used to verify or delete it.

get/allowed_caller_ids

Request

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

Response

Successful Response

lockedboolean required

Whether outbound calls are restricted to the listed caller IDs; false means any caller ID is allowed.

allowed_caller_idsstring[] required

Verified caller IDs (CLIs), E.164 (no leading "+").

Example response

{
  "allowed_caller_ids": [
    "12125551234",
    "12125551200"
  ],
  "caller_ids": [
    {
      "cli": "12125551234",
      "created_at": "2026-05-26T12:16:50.000Z",
      "id": 41,
      "verified": true
    },
    {
      "cli": "12125551200",
      "created_at": "2026-06-01T09:00:00.000Z",
      "id": 42,
      "verified": true
    },
    {
      "cli": "12125551235",
      "created_at": "2026-10-21T10:00:00.000Z",
      "id": 43,
      "verified": false
    }
  ],
  "limitations": {
    "capacity": {
      "12125551234": 10
    }
  },
  "locked": true
}

Changes

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