Use JayDeBeApi to access Talkdesk Data in Python

Access Talkdesk data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Talkdesk and the JayDeBeApi module to work with remote Talkdesk data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Talkdesk and visualize Talkdesk data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Talkdesk data in Python using SQL.

Talkdesk uses the OAuth 2.0 Client Credentials grant. There is no browser-based authorization step and no callback URL.

Set the following connection properties:

• AccountName: The name of your Talkdesk account.
• Region: The region where your Talkdesk instance is deployed. Supported values are US (default), EU, CA, AU, UK, and FedRamp.
• OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The Client Secret assigned to your custom OAuth application.

Creating a Custom OAuth Application

1. Log in to your Talkdesk account and select OAuth Clients from the navigation menu.
2. Click Create OAuth Client and give the client a descriptive name.
3. Set Grant Type to Client Credentials.
4. Click Add scopes and select the scopes for the data you want to access.
5. Click Create and copy the Client Id and Client Secret.

When you connect, the driver automatically requests an access token from Talkdesk, caches it, and refreshes it when it expires. Make sure the scopes selected for the application match the views you plan to query, or the token request can fail.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Talkdesk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.talkdesk.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:talkdesk:AccountName=myAccount;Region=US;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;"

Access Talkdesk data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData\CData JDBC Driver for Talkdesk 20XX\lib\cdata.jdbc.talkdesk.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Talkdesk:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:talkdesk:AccountName=myAccount;Region=US;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData\CData JDBC Driver for Talkdesk 20XX\lib\cdata.jdbc.talkdesk.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.talkdesk.TalkdeskDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Users;")


results = cursor.fetchall()
for row in results:
    print(row)

cursor.close()
conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for Talkdesk and start working with your live Talkdesk data in Python. Reach out to our Support Team if you have any questions.