Route-Caller-IDs

Get Route Caller IDs

Returns all route caller IDs available in your account.

When to use. List the caller IDs you can assign to outbound routes. To fetch a single record by its ID, use GET /route-caller-ids/{id}.

Parameters. Filter, order, limit and select fields by any response field.

Returns. An envelope with the matching records:

{
  "callerIds": [
    {
      "id": 9,
      "caller_id_name": "sales",
      "caller_id_number": "12125551234",
      "created_at": "2023-01-01 00:00:00",
      "is_active": 1
    }
  ]
}

Example. GET /api/route-caller-ids

get/{sub_domain}/api/route-caller-ids

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/route-caller-ids
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

Example response

{
  "callerIds": [
    {
      "caller_id_name": "demo",
      "caller_id_number": "12125551234",
      "created_at": "2023-06-01 10:44:03",
      "id": 2,
      "is_active": 0
    }
  ]
}

Changes

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