Skip to main content

​
Get details of all masking sessions

This method fetches details of all existing masking sessions.
GET
https://api.plivo.com/v1/Account/{Auth_ID}/Masking/Session

​
Attributes

NameTypeDescription
first_partystring (Optional)The actual phone number of the first party.
second_partystring (Optional)The actual phone number of the second party.
virtual_numberstring (Required)Virtual number assigned for the session.
statusstring (Optional)Allowed values: active, expired, all. Defaults to all.
created_timestring (Optional)Filters sessions by creation time (format: YYYY-MM-DD HH:MM[:ss[.uuuuuu]]). Supports variants:
created_time, created_time__gt, created_time__gte, created_time__lt, created_time__lte.
Go SDK: CreatedTimeEquals, CreatedTimeLessThan, CreatedTimeGreaterThan, CreatedTimeLessOrEqual, CreatedTimeGreaterOrEqual.
Default window: 7 days. Max: 30 days.
expiry_timestring (Optional)Filters sessions by expiry time (format: YYYY-MM-DD HH:MM[:ss[.uuuuuu]]). Supports variants:
expiry_time, expiry_time__gt, expiry_time__gte, expiry_time__lt, expiry_time__lte.
Go SDK: ExpiryTimeEquals, ExpiryTimeLessThan, ExpiryTimeGreaterThan, ExpiryTimeLessOrEqual, ExpiryTimeGreaterOrEqual.
Default window: 7 days. Max: 30 days.
durationstring (Optional)Filters sessions by duration in seconds. Supports variants:
duration, duration__gt, duration__gte, duration__lt, duration__lte.
Go SDK: DurationEquals, DurationLessThan, DurationGreaterThan, DurationLessOrEqual, DurationGreaterOrEqual.
Default window: 7 days. Max: 30 days.
limitinteger (Optional)Limits number of results returned.
Min: 1, Max: 20. Default: 20.
offsetinteger (Optional)Number of values to skip before displaying results. Used for pagination.
import plivo

client = plivo.RestClient(auth_id='<auth_id>', auth_token='<auth_token>')
response = client.masking_sessions.list_masking_session(status='active')
print(response)

{
  "api_id": "7d962130-8eb6-49f1-920b-ae4609bf6dfe",
  "response": {
    "meta": {
      "limit": 20,
      "next": null,
      "offset": 0,
      "previous": null,
      "total_count": 1
    },
    "objects": [
      {
        "amount": 0,
        "call_time_limit": 14400,
        "callback_method": "POST",
        "callback_url": "",
        "created_time": "2024-02-01 06:28:15 +0000 UTC",
        "duration": 1800,
        "expiry_time": "2024-02-01 06:58:15 +0000 UTC",
        "first_party": "919003459051",
        "first_party_play_url": "",
        "initiate_call_to_first_party": false,
        "interaction": null,
        "last_interaction_time": "",
        "modified_time": "2024-02-01 06:28:37 +0000 UTC",
        "record": true,
        "record_file_format": "mp3",
        "recording_callback_method": "POST",
        "recording_callback_url": "",
        "resource_uri": "/v1/Account/MAOTQ3NGFLNZRMZME1MT/Masking/Session/c28b77d4-21e7-43bd-9447-04bfee92e651/",
        "ring_timeout": 45,
        "second_party": "918197241073",
        "second_party_play_url": "",
        "session_uuid": "c28b77d4-21e7-43bd-9447-04bfee92e651",
        "status": "expired",
        "total_call_amount": 0,
        "total_call_billed_duration": 0,
        "total_call_count": 0,
        "total_session_amount": 0,
        "virtual_number": "912269947011"
      }
    ]
  }
}