Latest Legacy

Session Object

Attributes

session_uuid string

Unique identifier for the session.
first_party string

The actual phone number of the first participant.
second_party string

The actual phone number of the second participant.
virtual_number string

Plivo phone number to be dialed for connecting with the other participant.
record boolean

Determines the recording status for a phone call.
Defaults to false.
If set to true:

  • Call recording starts only when both participants have answered their calls.
  • Multiple calls within a session generate multiple recording files.
recording_callback_url string

URL to which the call recording is sent.
record_file_format string

Audio format for the recording.
Allowed values: mp3, wav Defaults to mp3.

recording_callback_method string

HTTP verb that should be used to invoke the URL configured as recording_callback_url.
Allowed values: GET, POST Defaults to POST.
session_expiry integer

Time in seconds after which the session mapping will expire.
Calls made to the virtual phone number after the session expiry will not be forwarded to the other participant; the default answer_url or application_url associated with the virtual number will be activated.
call_time_limit integer

Time in seconds after which the call should be disconnected.
This limit applies to all call legs within a session.
status string

Current status of the session.
active: The session is active, but no interactions are currently taking place.in-progress: One or more interactions are in progress within the session.expired: The session has expired.
initiate_call_to_first_party boolean

If set to true, Plivo will immediately make a call to the first party number. If the call is answered, it will be bridged with the second party.
Defaults to false.
callback_url string

URL on which to receive important session events and status updates.
callback_method string

HTTP verb to invoke the URL configured as callback_url.
Allowed values: GET, POST Defaults to POST.
ring_timeout integer

Time in seconds after which the ring should be disconnected.
Applies to both call legs.
Defaults to 120.
first_party_play_url string

URL that returns an MP3 or WAV file to be played to the first party before connecting to the second party.
second_party_play_url string

URL that returns an MP3 or WAV file to be played to the second party before connecting to the first party.
created_time timestamp

UTC time when the session was created (yyyy-mm-dd, hh-mm-ss).
modified_time timestamp

UTC time when the session was last modified (yyyy-mm-dd, hh-mm-ss).
expiry_time timestamp

UTC time when the session will expire (yyyy-mm-dd, hh-mm-ss).
last_interaction_time timestamp

UTC time when the latest interaction ended within the session (yyyy-mm-dd, hh-mm-ss).
total_call_count integer

Total count of all calls (individual call_uuids) made within the session.
total_call_amount string

Total billed amount for all calls within the session.
total_call_billed_duration integer

Total rounded bill duration for all calls within the session.
interaction string

Interaction object that contains all the interactions within the session. See the Interaction Object section below for details.
duration integer

Duration of the session in seconds.
amount string

Total charge incurred for creating the session.
total_session_amount string

Total charges incurred for hosting the session. This includes all call-related charges and session creation charges.

All list responses are returned from the most recent to the oldest date. The data covers the last 90 days. If search boundaries are not provided, the default search window is 7 days.