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.
CDR Details Webhooks: Push Data for Telephony Events
Paytia supports webhook push messages, enabling you to transmit real-time call information to a predefined URL. This functionality allows seamless programmatic decision-making within third-party applications.
For additional details on CDR (Call Detail Records) event logging, refer to Paytia Support Article on CDR Event Logging.
Webhook Data Overview
Paytia captures and passes comprehensive call-related data for both inbound and outbound call legs handled via its platform. Below is a detailed explanation of each field sent in the webhook payload.
Webhook Fields and Their Descriptions
| Field Name | Description |
|---|---|
originator |
Indicates the source of the call: "customer" (customer calling into your business) or "merchant" (your user calling out to a customer). |
inddi |
The destination phone number being called. |
incli |
The phone number initiating the inbound call. |
instate |
Call state during the inbound stage. |
intimes |
Start time of the inbound call leg (in UNIX timestamp format). |
intimee |
End time of the inbound call leg (in UNIX timestamp format). |
outddi |
The outbound destination phone number Paytia is calling. |
outcli |
The phone number Paytia presents as the caller ID for outbound calls. |
outstate |
Call state during the outbound stage. |
outtimes |
Start time of the outbound call leg (in UNIX timestamp format). |
outtimee |
End time of the outbound call leg (in UNIX timestamp format). |
outtimea |
Timestamp indicating when the outbound call was answered (in UNIX timestamp format). |
state |
The overall state of the call as handled by Paytia. |
statevalue |
Tracks progress through Paytia’s IVR services, providing detailed data on payment and call stages. |
agent_id |
The unique identifier of the agent who performed a service on the Paytia platform. |
hangFirstDir |
Specifies which call leg ended the call: "in" (inbound leg) or "out" (outbound leg), in context to the originator (customer or merchant). |
hangFirstEnd |
Indicates which endpoint hung up first: "local" (Paytia platform) or "remote" (external party). |
hangOutCause |
Contains SIP error messages received during call handling (if applicable). |
Using the Webhook
To utilize this webhook feature:
- Define the receiving URL in your application to accept webhook data from Paytia.
- Parse and handle the webhook payload to programmatically manage real-time call events, IVR navigation, or payment updates.
Examples of Use Cases
- Real-Time Call Management: Automatically track call progress for customers and agents, including IVR interactions and payment updates.
- Error Handling: Identify call disconnect reasons through SIP error codes and automate troubleshooting.
- Performance Metrics: Collect and analyze data such as call start/end times, durations, and agent handling for reporting.
For further assistance, contact Paytia Support.
More in API
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.
Paytia API exception handling
The webhooks we send when something goes wrong mid-payment — the customer rejects the amount, the call drops, the card fails. Here's each case and what lands on your endpoint.
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.