Paytia webhooks

CDR Details Webhooks: Push Data for 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 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:

  1. Define the receiving URL in your application to accept webhook data from Paytia.
  2. 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.


    • Related Articles

    • What does the call records log menu allow me to do?

      The call records menu allows you to see all the inbound and outbound telephone calls made through the Paytia platform. This menu gives access to additional detailed information by using the Action buttons, View and Webhooks. Call records page Access ...
    • CDR details view

      What does the Call records details view show me? The Call records details (CDR) view is available to show detailed information relating to each call that takes place over the Paytia system. From here you have access to a logged record of each event ...
    • Call records report

      Call Records Report Guide The Call Records Report provides detailed information about telephone calls and transactions processed through the Paytia system. Below is an instructional guide on how to access, navigate, and utilize this report ...
    • API details

      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 ...
    • Data privacy

      Data Privacy Between Paytia and Its Merchant Transactions This article provides detailed questions and answers about data privacy related to transactions processed by Paytia. Table of Contents AWS Unique ID CDR ID Reference Number Account Number ...