XML request

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

    Note: The maximum allowed size of the XML document in response to an HTTP request from Plivo to your application is 100 Kb.

    Voice calls

    Parameters Plivo sends for voice calls

    CallUUID

    A unique identifier for this call.

    From

    The phone number of the party that initiated the call, including the country code.

    If the call is inbound, then this parameter is the caller’s caller ID. If the call is outbound — 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, including the country code.

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

    ForwardedFrom

    Set only when a received call 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. If the call is hung up, the CallStatus will be 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, and the call will be in a ringing state. If you’re using the Call API, the direction will be outbound and the call will be in an answered state.

    ALegUUID

    Contains a unique identifier that identifies the first leg of an outbound call.

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

    ALegRequestUUID

    Contains a unique request identifier that Plivo returns for an API request during an outbound call.

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

    HangupCause

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

    If a call is not hung up, this parameter will not be present.

    Duration

    Contains the duration of the call in seconds.

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

    BillDuration

    Contains the billed duration of the call in seconds.

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