CDR Details Webhooks: Push Telephony Events
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 ...
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 extra API key security on Paytia?
How to Add Extra API Key Security on Paytia Adding extra security to your API integration ensures a more secure and streamlined experience when connecting to the Paytia platform. Follow these instructions to generate an API key, activate ...
How do I use Paytia Webhooks?
Configuring Webhooks in the Paytia Merchant Administrative Portal Webhooks enable the Paytia platform to send notifications and data to third-party service providers. These notifications are essential for integrating the Paytia Agent Capture Assist ...
How to Add an API Key on Paytia
How to Add an API Key on Paytia Adding an API key to your Paytia account is essential for integrating external applications or services with your merchant account on the Paytia platform. Follow the steps below to generate and manage an API key. Steps ...
Integrating Paytia: Guide to Connection Points
Paytia provides secure payment solutions that connect with host systems, telephony, and payment gateways. This guide outlines the primary connection points and how businesses can utilise Paytia for a streamlined payment processing ...
Paytia API: Braintree gateway_customer_id
Error conditions When using the Paytia API and connecting to the Braintree payment gateway, Paytia has added the ability for a developer to set their own Customer ID values as the Braintree Customer ID. API error message for control use cases: Case ...
Paytia API exception handling
Paytia API Exception Handling The Paytia API services provide status update webhooks to track processes and status changes. These updates include standard API posts as well as exception handling for telephony-related processes. Below are details ...
Still need help?
Our support team is here to help. Submit a ticket and we'll get back to you within one business day.