This guide explains how to configure Grandstream IP PBXs to connect to an external SQL database and use it for contacts synchronization and real-time inbound caller name lookup.

Instead of manually maintaining phone book records on the PBX, the system queries the external database or syncs from it automatically, improving consistency and reducing administrative effort.

The configuration workflow includes:

1. Configure the global SQL database connection
2. (Optional) Sync contacts from the external database
3. Configure inbound routes to perform database caller name lookup

PREREQUISITES

Before configuring the PBX, ensure the following:

• PBX running a compatible firmware (See Supported Models section).
• A SQL database server is available (MySQL or SQL Server).
• Network connectivity exists between the PBX and the database server.
• A database and user account are created.
• The database user has, at a minimum, SELECT privileges on required tables.

PBX CONFIGURATION

Configure Global SQL Integration

The PBX first needs a global database connection that other features can reference. This connection is configured once and reused by modules such as Contacts Sync and Inbound Routes’ third-party database lookup.

To configure the SQL integration, please refer to the steps below:

1. Navigate to System Settings→3rd Party Database Integration.

2. Configure the fields as described below.

3. Click Start under “Test Connection” to verify connectivity.
4. If the test succeeds, click “Save”.

Configure Contacts Sync (Optional)

After the database connection is successfully established, an additional Contact Synchronization tab becomes available.

The PBX can synchronize phone book records from the external database into its internal LDAP directory. The synchronized contacts are then exposed to endpoints through the PBX LDAP server.

To configure contact synchronization:

1. Navigate to Call Features → Contacts → 3rd Party Database Sync.
2. Enable Contacts Sync.
3. Specify the table and column mappings.
4. Configure the synchronization schedule, or run a manual sync.

The configurable parameters are described below:

When synchronization runs, the PBX imports records from the defined table and updates its internal contact storage. To verify the synced LDAP Phonebook:

1. Navigate to System Settings→LDAP Server→LDAP Phonebook.
2. Confirm a new phonebook with the configured name is present.

3. Verify that the 3rd party database synced contacts are listed and searchable.

Configure Inbound Routes Search

This feature allows the PBX to perform a real-time lookup in an external SQL database when an inbound call is received. If the inbound caller number matches a record in the database, the associated name is returned and displayed as the caller ID.

This lookup operates independently of the contact synchronization feature. Instead of importing data, the PBX queries the external database dynamically during call processing.

To configure third-party database lookup on inbound routes, please refer to these instructions:

1. Navigate to Extension/Trunk → Inbound Routes
2. Enable 3rd Party Database Search.

3. Configure the Query Key fields described below.

Based on the configured query keys, the PBX automatically generates and executes a SQL query in the following format:

SELECT <Caller Name Column>
FROM <Table>
WHERE <Number Column> LIKE '%[INBOUND_NUMBER]%';

The inbound caller number is dynamically substituted at call time.

SUPPORTED MODELS

The following table shows the list of models that support the 3rd Party SQL Database Integration.