Skip to main content
API 3CX Telecom Integration

BlueRockTEL API: Example Usage with the 3CX Call Flow Designer

By BlueRockTEL Team

The BlueRockTEL API

BlueRockTEL exposes several API routes that allow you to query your customer database in real time. These routes were designed notably for integration with the 3CX Call Flow Designer, but they apply to any system requiring on-the-fly customer identification.

Basic Identification by Phone Number

/api/isKnownPhoneNumber

This route identifies a caller from their phone number. The search covers:

  • The customer record's primary number
  • All phone numbers of associated contacts
  • Extensions listed in customer records

The search uses indexing for near-instant results, even on a large customer base.

/api/isKnownCustomerAccount

Used when a caller cannot be identified by their phone number but provides their BlueRockTEL account number. This route validates the account's existence and returns the associated information.

VIP Customer Identification

BlueRockTEL allows you to categorise your customers. The following routes detect whether a caller holds VIP status:

  • /api/isVipByPhoneNumber — Checks VIP status via the calling number
  • /api/isVipByCustomerAccount — Checks VIP status via the account number

This allows, for example, automatically routing VIP calls to a dedicated queue or a dedicated technician.

On-Call Duty Contracts

These routes verify whether a customer has an active on-call duty contract:

  • /api/hasOnCallDutyContractByPhoneNumber — Via the calling number
  • /api/hasOnCallDutyContractByCustomerAccount — Via the account number

Typical use case: route incoming calls outside business hours to an on-call team only for customers who have subscribed to that service — without activating it for everyone.

Use Case in the 3CX Call Flow Designer

By combining these routes in a Call Flow Designer, you can build intelligent call flows:

  1. The caller dials your number
  2. The CFD queries /api/isKnownPhoneNumber — if unidentified, it requests the account number
  3. The CFD checks /api/isVipByPhoneNumber — if VIP, the call is routed to the priority queue
  4. Outside business hours, the CFD checks /api/hasOnCallDutyContractByPhoneNumber — only eligible customers reach the on-call team
Back to resources