COcommpeak
Dynamic-Caller-IDs

Create a Dynamic Caller ID rule

Creates a Dynamic Caller ID rule. condition and action are required; prefix is required for the country and prefix conditions and caller_id_number for the fixed action. The blocked action is available only to accounts allowed to use any Caller ID. Trial accounts can only create a rule for all destinations with their verified phone number. Returns 422 with errors when the rule is rejected.

post/dynamic_caller_ids

Request

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

Request body

Example request

{
  "dynamic_caller_id": {
    "action": "fixed",
    "caller_id_number": "12125551234",
    "condition": "country",
    "name": "USA",
    "prefix": "1"
  }
}

Response

Successful Response

Example response

{
  "dynamic_caller_id": {
    "action": "fixed",
    "caller_id_name": "John Doe",
    "caller_id_number": "12125551234",
    "condition": "country",
    "id": 12,
    "name": "USA",
    "prefix": "1",
    "sip_accounts": [
      "2BZgTQS4X0qaUEHt4YF-oQ"
    ],
    "verified": true
  }
}

Changes

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