VOOZH about

URL: https://www.cdata.com/kb/tech/aircall-odbc-php.rst

⇱ Natively Connect to Aircall Data in PHP


Natively Connect to Aircall Data in PHP

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
The CData ODBC driver for Aircall enables you to create PHP applications with connectivity to Aircall data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Aircall into your LAMP or WAMP stack to build Aircall-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Aircall data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Start by setting the Profile connection property to the location of the Aircall Profile on disk (e.g. C:\profiles\Aircall.apip). Next, set the ProfileSettings connection property to the connection string for Aircall (see below).

Aircall API Profile Settings

In Aircall, go to your company settings and create a new API key to receive an API ID and API token. Combine them as

APIId:APIToken
for the APIKey property.

Establish a Connection

Open the connection to Aircall by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC API Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Calls WHERE Status = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Calls WHERE Status = ?");
$success = odbc_execute($query, array('completed'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Direction FROM Calls WHERE Status = 'completed'");
 

Process Results

Access a row in the result set as an array with the function.

$conn = odbc_connect("CData ODBC Aircall data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Direction FROM Calls WHERE Status = 'completed'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

Display the result set in an HTML table with the function.

$conn = odbc_connect("CData ODBC Aircall data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Calls WHERE Status = ?");
$success = odbc_execute($query, array('completed'));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Aircall-specific adaptations of the PHP community documentation for all ODBC functions.