Session Object
Number Masking
Session Object
Attributes
| Field | Type | Description |
|---|---|---|
| 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 true: (1) Call recording starts only when both participants have answered their calls. (2) 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 for invoking 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 after this will not be forwarded. |
| call_time_limit | integer | Time in seconds after which the call should be disconnected. Applies to all call legs. |
| status | string | Current session status: active, in-progress, or expired. |
| initiate_call_to_first_party | boolean | If true, Plivo calls the first party immediately and bridges if answered. Defaults to false. |
| callback_url | string | URL on which to receive important session events and status updates. |
| callback_method | string | HTTP verb for invoking callback_url. Allowed values: GET, POST. Defaults to POST. |
| ring_timeout | integer | Time in seconds after which the ring should be disconnected. Defaults to 120. |
| first_party_play_url | string | URL returning MP3/WAV file to play to first party before connecting. |
| second_party_play_url | string | URL returning MP3/WAV file to play to second party before connecting. |
| 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 (yyyy-mm-dd, hh-mm-ss). |
| total_call_count | integer | Total number of individual calls (call_uuids) in the session. |
| total_call_amount | string | Total billed amount for all calls within the session. |
| total_call_billed_duration | integer | Total rounded bill duration (seconds) for all calls. |
| interaction | string | Interaction object containing session interactions. See Interaction Object |
| duration | integer | Duration of the session in seconds. |
| amount | string | Total charge incurred for creating the session. |
| total_session_amount | string | Total charges for hosting the session, including call and session creation fees. |
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.