v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Dynamic Caller IDs (DID)

Get dynamic caller ids by params

The Get dynamic caller ids by params gives you the option to retrieve the caller ids specified by different params. You can see the filters that can be used as a variable below:

Request

No request body is required for this endpoint.

filterby (path parameter) - The filter to be applied for retrieving dynamic caller IDs for the campaign.
allowed filter by: campaign_id, prefix, caller_id_number, caller_id_name, is_active, created_at_from, created_at_till, is_blocked

get/did/campaign_id/{filterby}

Response

Successful operation

Example response

{
  "dynamicCallerIds": [
    {
      "caller_id_name": "kazahstan",
      "caller_id_number": "123123123",
      "campaign_id": "1",
      "created_at": "2021-04-12 16:11:07",
      "id": 10,
      "is_active": "0",
      "is_blocked": "0",
      "parent_id": null,
      "prefixes": [
        {
          "dynamic_caller_id_id": "10",
          "id": 591,
          "prefix": "79"
        }
      ],
      "used_by_sms": "0"
    },
    {
      "caller_id_name": "test",
      "caller_id_number": "123123123",
      "campaign_id": "1",
      "created_at": "2021-11-16 15:07:20",
      "id": 14,
      "is_active": "0",
      "is_blocked": "0",
      "parent_id": null,
      "prefixes": [
        {
          "dynamic_caller_id_id": "14",
          "id": 609,
          "prefix": "972"
        }
      ],
      "used_by_sms": "0"
    }
  ]
}