{
  "api_id": "32d333cb-3709-4b9b-b27b-3296aca6e1cc",
  "message": "Session updated",
  "session": {
    "first_party": "919003459051",
    "second_party": "918197241073",
    "virtual_number": "912269947011",
    "status": "active",
    "initiate_call_to_first_party": false,
    "first_party_pin": "1234",
    "second_party_pin": "4321",
    "is_pin_authentication_required": true,
    "generate_pin": false,
    "generate_pin_length": 4,
    "pin_ prompt_play": "https://play.s3.eu-north-1.amazonaws.com/pin_prompt.wav",
    "pin_retry": 1,
    "pin_retry_wait": "5",
    "incorrect_pin_play": "https://play.s3.eu-north-1.amazonaws.com/incorrect_pin.wav",
    "session_uuid": "c28b77d4-21e7-43bd-9447-04bfee92e651",
    "callback_url": "",
    "callback_method": "POST",
    "created_time": "2024-02-01 06:28:15 +0000 UTC",
    "modified_time": "2024-02-01 06:28:37 +0000 UTC",
    "expiry_time": "2024-02-01 06:58:15 +0000 UTC",
    "duration": 1800,
    "amount": 0,
    "call_time_limit": 14400,
    "ring_timeout": 45,
    "first_party_play_url": "",
    "second_party_play_url": "",
    "record": true,
    "record_file_format": "mp3",
    "recording_callback_url": "",
    "recording_callback_method": "POST",
    "interaction": null,
    "total_call_amount": 0,
    "total_call_count": 0,
    "total_call_billed_duration": 0,
    "total_session_amount": 0,
    "last_interaction_time": ""
  }
}

​
Update a number masking session

The following resource allows you to update the session.

POST
https://api.plivo.com/v1/Account/{Auth ID}/Masking/Session/{session_uuid}

​
Attributes

NameTypeDescription
recordbooleanRecording status for a phone call. Defaults to false. If set to true:
  • Call recording starts only when both parties have answered their calls.
  • Multiple calls within a session generate multiple recording files.
recording_callback_urlstringURL to which the call recording is sent.
record_file_formatstringAudio format for the recording. Allowed values: mp3, wav. Defaults to mp3.
recording_callback_methodstringHTTP verb to invoke the URL configured as recording_callback_url. Allowed values: GET, POST. Defaults to POST.
session_expiryintegerTime in seconds after which the session mapping will end. Calls made to the virtual phone number after the session ends are not forwarded to the other party. The default answer_url or application_url associated with the virtual number will be activated. Defaults to 3,600.
call_time_limitintegerTime in seconds after which the call will be disconnected. This applies to all call legs within a session. Default: 3,600
callback_urlstringURL to receive important session events and status updates.
callback_methodstringHTTP verb to invoke the URL configured as callback_url. Allowed values: GET, POST. Defaults to POST.
ring_timeoutintegerTime in seconds after which the ring will be disconnected. Applies to both call legs. Defaults to 120.
first_party_play_urlstringURL that returns an .mp3 or .wav file to be played to the first party before connecting to the second party.
second_party_play_urlstringURL that returns an .mp3 or .wav file to be played to the second party before connecting to the first party.
first_partystringThe actual phone number of the first participant. This update is applicable only when the session is created with create_session_with_single_party set to true.
second_partystringThe actual phone number of the second participant. An update is applicable only when the session is created with create_session_with_single_party as true.
{
  "api_id": "32d333cb-3709-4b9b-b27b-3296aca6e1cc",
  "message": "Session updated",
  "session": {
    "first_party": "919003459051",
    "second_party": "918197241073",
    "virtual_number": "912269947011",
    "status": "active",
    "initiate_call_to_first_party": false,
    "first_party_pin": "1234",
    "second_party_pin": "4321",
    "is_pin_authentication_required": true,
    "generate_pin": false,
    "generate_pin_length": 4,
    "pin_ prompt_play": "https://play.s3.eu-north-1.amazonaws.com/pin_prompt.wav",
    "pin_retry": 1,
    "pin_retry_wait": "5",
    "incorrect_pin_play": "https://play.s3.eu-north-1.amazonaws.com/incorrect_pin.wav",
    "session_uuid": "c28b77d4-21e7-43bd-9447-04bfee92e651",
    "callback_url": "",
    "callback_method": "POST",
    "created_time": "2024-02-01 06:28:15 +0000 UTC",
    "modified_time": "2024-02-01 06:28:37 +0000 UTC",
    "expiry_time": "2024-02-01 06:58:15 +0000 UTC",
    "duration": 1800,
    "amount": 0,
    "call_time_limit": 14400,
    "ring_timeout": 45,
    "first_party_play_url": "",
    "second_party_play_url": "",
    "record": true,
    "record_file_format": "mp3",
    "recording_callback_url": "",
    "recording_callback_method": "POST",
    "interaction": null,
    "total_call_amount": 0,
    "total_call_count": 0,
    "total_call_billed_duration": 0,
    "total_session_amount": 0,
    "last_interaction_time": ""
  }
}