v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Route Caller IDs (DID)

Get Route Caller IDs

This endpoint makes an HTTP GET request to retrieve the caller IDs associated with a specific route. The request does not require a request body as it is a GET request. The response will include an array of caller IDs along with their associated details.

Response Body

The response will be in JSON format with a status code of 200. It will contain an array of caller IDs, where each caller ID object includes the following properties:

  • id (string): The unique identifier for the caller ID.

  • caller_id_name (string): The name associated with the caller ID.

  • caller_id_number (string): The phone number associated with the caller ID.

  • created_at (string): The timestamp indicating when the caller ID was created.

  • is_active (string): Indicates whether the caller ID is currently active.

get/route-caller-ids

Response

successful operation

Example response

{
  "callerIds": [
    {
      "caller_id_name": "test1",
      "caller_id_number": "4477123123",
      "created_at": "2023-04-25 05:32:00",
      "id": "1",
      "is_active": "1"
    },
    {
      "caller_id_name": "test2",
      "caller_id_number": "9721234567",
      "created_at": "2023-04-25 05:36:13",
      "id": "2",
      "is_active": "1"
    },
    {
      "caller_id_name": "test3",
      "caller_id_number": "97230000000",
      "created_at": "2023-05-04 11:35:43",
      "id": "3",
      "is_active": "1"
    },
    {
      "caller_id_name": "agent",
      "caller_id_number": "44771234567",
      "created_at": "2023-06-01 10:44:08",
      "id": "4",
      "is_active": "1"
    },
    {
      "caller_id_name": "agentPPQ",
      "caller_id_number": "1201456456",
      "created_at": "2023-06-01 10:44:08",
      "id": "5",
      "is_active": "1"
    },
    {
      "caller_id_name": "test4",
      "caller_id_number": "12120001215",
      "created_at": "2023-06-01 10:44:08",
      "id": "6",
      "is_active": "1"
    },
    {
      "caller_id_name": "test5",
      "caller_id_number": "972972953345111",
      "created_at": "2023-06-01 10:44:08",
      "id": "7",
      "is_active": "1"
    },
    {
      "caller_id_name": "test6",
      "caller_id_number": "972521234567",
      "created_at": "2023-06-01 10:44:08",
      "id": "8",
      "is_active": "1"
    },
    {
      "caller_id_name": "test7",
      "caller_id_number": "444477123456",
      "created_at": "2023-06-01 10:44:08",
      "id": "9",
      "is_active": "1"
    },
    {
      "caller_id_name": "erezoffice",
      "caller_id_number": "972545640000",
      "created_at": "2023-06-01 10:44:08",
      "id": "10",
      "is_active": "1"
    },
    {
      "caller_id_name": "softphone",
      "caller_id_number": "44770000123",
      "created_at": "2023-06-01 10:44:08",
      "id": "11",
      "is_active": "1"
    },
    {
      "caller_id_name": "caller1",
      "caller_id_number": "972584545544",
      "created_at": "2024-09-10 11:58:25",
      "id": "15",
      "is_active": "1"
    }
  ]
}