Route-Caller-IDs

Enable/Disable Route CallerID

Enables or disables an existing route caller ID.

Parameters.

  • id (integer, required): ID of the route caller ID to update.
  • action (integer, required): 1 to enable, 0 to disable.

Returns. The updated record inside the callerIds envelope.

Notes. A caller ID that is in use as a user caller ID or as the last caller ID of an outbound route cannot be disabled until it is replaced.

Example.

PUT /api/route-caller-ids
{
  "id": 9,
  "action": 0
}
put/{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)

Request body

idstring required

ID of the route caller ID to update.

actionstring required

Action to perform: 1 = enable, 0 = disable.

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.