Configure the “callback_url” with your web server URL to receive important session events and status updates. Plivo passes these events to the callback URL.
SessionFirstPartyInitiated |
Triggered when a phone call is initiated toward the first party. This event is emitted when the call attempt is made toward the first party. If Plivo fails to initiate the call, this event will not be emitted. |
SessionFirstPartyRinging |
Triggered when the first party’s phone starts ringing. |
SessionFirstPartyAnswer |
Triggered when the first party answers the call. |
SessionFirstPartyComplete |
Triggered when the first party disconnects the call. |
SessionFirstPartyFailed |
Triggered when the first party’s call fails to be completed. |
SessionSecondPartyInitiated |
Triggered when a call is initiated toward the second party. This event is emitted when the call attempt is made toward the second party. If Plivo fails to initiate the call, this event will not be emitted. |
SessionSecondPartyRing |
Triggered when the second party’s phone starts ringing. |
SessionSecondPartyAnswer |
Triggered when the second party answers the call. |
SessionSecondPartyComplete |
Triggered when the second party disconnects the call. |
SessionSecondPartyFailed |
Triggered when the second party’s call fails to be completed. |
SessionVirtualNumberAnswer |
Triggered when either the first party or second party calls the virtual number, and the call lands on the virtual number.Note: Virtual phone numbers are on auto-answer and do not have a ring state. |
For each event, the below attributes will be posted to your web server
EventName (string) |
Event that triggered this callback. This parameter will have one of the values from the list of events above. |
EventTimestamp (string) |
Timestamp in UTC at which the event occurred. |
SessionUUID (string) |
Unique ID of the masking session for which callback is sent. |
FirstParty |
The real phone number of the first party used for the interaction.
|
SecondParty |
The real phone number of the second party used for the interaction.
|
VirtualNumber |
The Plivo virtual phone number used for the interaction. |
Direction |
The direction of the interaction from Plivo’s perspective. |
CallBilledDuration |
Duration in seconds for which the call was billed. |
CallDuration |
Duration in seconds for which the party was actually on the call. |
CallRate |
Per-minute rate charged for the call |
PlivoHangupCause |
Reason for the call termination. |
PlivoHangupCauseCode |
A unique integer code for the termination cause. Refer to our list of hangup causes and sources. |
SequenceNumber (string) |
Indicates the sequence of the callback. Helpful to sort the callback events posted to the recording_callback_url.
|