Getting Started
- QUICKSTART GUIDE
Concepts
- CONCEPTS
API Reference
Session Object
Number Masking
Copy
Ask AI
import plivo
client = plivo.RestClient(auth_id='<auth_id>', auth_token='<auth_token>')
response = client.masking_sessions.get_masking_session("session_uuid")
print(response)
Copy
Ask AI
{
"api_id": "678c8b24-b703-43aa-8690-d28e7f163d18",
"response": {
"first_party": "919003459051",
"second_party": "918197241073",
"virtual_number": "912269947011",
"status": "expired",
"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": ""
}
}
Get details of a number masking session
This method fetches details of an existing masking session.
GET
Copy
Ask AI
https://api.plivo.com/v1/Account/{Auth ID}/Masking/Session/{session_uuid}
Attributes
No attributes need to be passed.
Copy
Ask AI
import plivo
client = plivo.RestClient(auth_id='<auth_id>', auth_token='<auth_token>')
response = client.masking_sessions.get_masking_session("session_uuid")
print(response)
Copy
Ask AI
{
"api_id": "678c8b24-b703-43aa-8690-d28e7f163d18",
"response": {
"first_party": "919003459051",
"second_party": "918197241073",
"virtual_number": "912269947011",
"status": "expired",
"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": ""
}
}
Copy
Ask AI
import plivo
client = plivo.RestClient(auth_id='<auth_id>', auth_token='<auth_token>')
response = client.masking_sessions.get_masking_session("session_uuid")
print(response)
Copy
Ask AI
{
"api_id": "678c8b24-b703-43aa-8690-d28e7f163d18",
"response": {
"first_party": "919003459051",
"second_party": "918197241073",
"virtual_number": "912269947011",
"status": "expired",
"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": ""
}
}
Assistant
Responses are generated using AI and may contain mistakes.