Retrieve the full list of dynamic caller IDs in your account.

When to use. Browse or export your dynamic caller IDs, or look up a caller ID's id, number and active status before enabling or disabling it. To retrieve only the caller IDs that match a filter, use GET /did/campaign_id/{filterby}.

Parameters. Use the fields query parameter with a semicolon-separated list to return only the fields you need, for example caller_id_number;caller_id_name;is_active. Include prefixes in that list to also return the dialing prefixes associated with each caller ID, which are omitted by default.

Returns. { "dynamicCallerIds": [ ... ], "total_did": N }.

Example. GET /api/did/fields/caller_id_number;caller_id_name;is_active;prefixes

{
  "dynamicCallerIds": [
    {
      "caller_id_name": "demo",
      "caller_id_number": "12125551234",
      "created_at": {
        "date": "2024-10-15 15:53:52.000000",
        "timezone": "UTC",
        "timezone_type": 3
      },
      "id": 1,
      "is_active": 1,
      "is_blocked": 0,
      "prefixes": [
        {
          "campaign_id": 396,
          "dynamic_caller_id_id": 1,
          "id": 1,
          "prefix": "1"
        },
        {
          "campaign_id": 396,
          "dynamic_caller_id_id": 1,
          "id": 3,
          "prefix": "*"
        }
      ]
    }
  ]
}