Route-Caller-IDs

Create Route CallerID

Creates a new route caller ID.

Parameters.

  • caller_id_name (string, required): Caller ID name. Alphanumeric.
  • caller_id_number (string, required): Caller ID number. Digits, optionally prefixed with +, and the placeholders X, Z, N.
  • is_active (integer, optional): Enabled flag, 1 = active, 0 = disabled. Defaults to 1.

Returns. The created record inside the callerIds envelope.

Example.

POST /api/route-caller-ids
{
  "caller_id_name": "sales",
  "caller_id_number": "12125551234",
  "is_active": 1
}
post/{sub_domain}/api/route-caller-ids

Request

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

Path parameters

sub_domainstring required

PBX Name (subdomain)

Request body

caller_id_namestring required

Caller ID name. Alphanumeric.

caller_id_numberstring required

Caller ID number. Digits, optionally prefixed with +, and the placeholders X, Z, N.

is_activestring nullable

Enabled flag: 1 = active, 0 = disabled. Optional, defaults to 1.

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.