COcommpeak
Dynamic-Caller-IDs

List Dynamic Caller ID rules

Returns the customer's Dynamic Caller ID rules. A rule decides which Caller ID is presented for calls of a SIP account: for all destinations (condition any), a country (country, prefix is the country dialing code) or a destination prefix (prefix), the Caller ID is either passed as sent by the caller (action from), anonymous (blocked) or replaced by caller_id_number / caller_id_name (fixed). Rules with a fixed Caller ID that is not verified (verified false) can't be assigned to SIP accounts. sip_accounts lists the display tokens of the SIP accounts using the rule.

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

Response

Successful Response

Example response

{
  "dynamic_caller_ids": [
    {
      "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.