COcommpeak
Allowed-Caller-IDs

Add a Caller ID and place its verification call

Adds a Caller ID to the account and places a verification call to it; the call reads out a verification code to submit with the verify method. cli is the phone number in E.164 format. Calling this again for a Caller ID that is not verified yet places a new verification call. The number of verification calls is limited per number and per account; once the limit is reached the request is rejected until later. Returns 422 with errors when the Caller ID can't be added or the call can't be placed.

post/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

Request body

clistring required

Phone number in E.164 format.

Example request

{
  "cli": "12125551234"
}

Response

Successful Response

Example response

{
  "caller_id": {
    "cli": "12125551234",
    "created_at": "2026-10-21T10:00:00.000Z",
    "id": 42,
    "verified": false
  }
}

Changes

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