XML Request

When Plivo makes a synchronous HTTP request to your application, the API expects an XML document in response. Plivo also sends a few parameters with the HTTP request that your application can act upon before responding.

Voice Calls

Parameters sent by Plivo for voice calls

CallUUID

A unique identifier for this call.

From

The phone number of the party that initiated the call along with the country code.

If the call is inbound, then it is the caller's caller ID. If the call is outbound i.e. initiated via a request to the API, then this is the phone number you specify as the caller ID.

To

The phone number of the called party with the country code.

If the call is inbound, then it’s your incoming phone number. If the call is outbound, then it’s the phone number you provided to call.

ForwardedFrom

This parameter is set only when the call received by Plivo is a forwarded call. Its value depends on the caller’s carrier. Not all carriers pass this information.

CallStatus

Indicates the status of the call.

The value is set to either ringing, in-progress or completed. In case the call is hung up, the CallStatus is set to completed for inbound calls and to completed, busy, failed, timeout or no-answer for outbound calls.

Direction

Indicates the direction of the call.

In most cases this will be inbound, wherein the call would be in a ringing state. If you are using the Call API, the direction will be outbound, wherein the call will be in an answered state.

ALegUUID

This contains a unique identifier which identifies the first leg of the call in case it is outbound.

If the call direction is inbound, this parameter will not present.

ALegRequestUUID

Contains a unique request identifier which is returned by Plivo in case of aAPI request during an outbound call.

In case the call direction is inbound, this parameter will not be present.

HangupCause

Contains the standard telephony hangup cause of a call (inbound and outbound).

In case the call is not hung up, this parameter will not be present.

Duration

Contains the duration of the call in seconds.

In case the call is not hung up, this parameter will not be present.

BillDuration

Contains the billed duration of the call in seconds.

In case the call is not hung up, this parameter will not be present.