API details
The API Details View exposes the internal exchanges between Paytia's telephony and API services. It's a troubleshooting tool — here's how to open it and how to read what's there.
What Can I See in the API Details View?
The API Details View provides an in-depth look at the internal API exchanges between Paytia's telephony and API services. This feature is designed for troubleshooting and offers transparency into the data passed internally within the Paytia platform.
Purpose of the API Details View
- Troubleshooting: Helps diagnose and resolve issues related to telephony and API integration.
- Transparency: Displays the flow of data processed within Paytia services.
- Advanced Reporting: Offers detailed information about internal API processes associated with call records.
How to Access the API Details View
Ensure You Have the Advanced Log License
- The API Details View is part of the Paytia Advanced Log License, which includes access to Call Records.
- Verify your account has this license enabled.
Navigate to Call Records
- In the Log Information menu, click on Call Records to open the call log history page.
- You will see a list of call logs with action buttons.
Click the API Details Button
- Locate the API Details button under the action column.
- Clicking this button opens the API process flow information for the selected call.
What Information Does the API Details View Provide?
When accessing the API Details View, you can see a detailed table of internal API transactions. Each row in the table contains the following columns:
| Column Header | Description |
|---|---|
| URI | The API endpoint that was accessed. |
| Method | The HTTP method used (e.g., POST). |
| Request Params | The parameters sent in the API request. |
| Response | The data Paytia returned in response to the request. |
| Actual Response | The processed result or status of the API interaction. |
| Time | The exact time the API call occurred. |
Example Data View
In the API details table, you can review:
-
Specific data passed between Paytia services.
-
The API response for each request, including success or failure status.
Time-stamped logs for precise tracking and analysis.
Use Case for API Details View
- Debugging Call Issues: Understand why a specific call or transaction may not have completed successfully.
- Validating API Data: Ensure that API requests and responses align with expected formats and requirements.
- Compliance and Reporting: Keep detailed records of API transactions for audits or troubleshooting purposes.
Additional Resources
For further details, refer to the Call Records article for a complete guide to navigating and using call history logs. If you encounter issues, contact Paytia Support
for assistance.
More in API
CDR Details Webhooks: Push Data for Telephony Events
Paytia can push call information to a URL you nominate as it happens, so a third-party application can act on it straight away. Here's how the CDR webhook works and what it sends.
How do I add an enhanced API key security on Paytia?
Generating a key is step one. This covers the controls worth switching on afterwards — IP restriction and token-based access — and how to pre-authorise your requests.
How do I use Paytia Webhooks?
Webhooks let our platform send notifications and data out to third-party providers — useful when you're integrating Agent Capture Assist with an external telephony partner. Setting one up takes a couple of minutes.
How to Add an API Key on Paytia
Generating an API key from Account Security then API Secret Key, plus the optional IP restriction that limits where the key can be used from.
Integrating Paytia: A Comprehensive Guide to the Connection Points you must consider
There are three places Paytia connects to your world — your host system, your telephony, and your payment gateway. This walks through what each connection needs so you can plan an integration properly.
Paytia API - Braintree payment gateway - using the gateway_customer_control field to control the passed value in the gateway_customer_id field
The gateway_customer_control field lets you set your own Braintree customer IDs. Here are the valid values and the exact errors you'll get when one is wrong.
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.