Skip to content

UserCallRecordingGetRequest23

Bases: OCIRequest

Get the Call Recording attributes for a user. The response is either a UserCallRecordingGetResponse23 or an ErrorResponse.

The following parameters are not returned for service instance:
  - pauseResumeNotification
  - enableCallRecordingAnnouncement
  - enableRecordCallRepeatWarningTone
  - recordCallRepeatWarningToneTimerSeconds

Attributes:

user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallRecordingGetRequest23(OCIRequest):
    """Get the Call Recording attributes for a user.
        The response is either a UserCallRecordingGetResponse23 or an ErrorResponse.

        The following parameters are not returned for service instance:
          - pauseResumeNotification
          - enableCallRecordingAnnouncement
          - enableRecordCallRepeatWarningTone
          - recordCallRepeatWarningToneTimerSeconds

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to the UserCallRecordingGetRequest23. The response contains the user's Call Recording option information.

The following parameters are not returned for service instance:
  - pauseResumeNotification
  - enableCallRecordingAnnouncement
  - enableRecordCallRepeatWarningTone
  - recordCallRepeatWarningToneTimerSeconds

The enableVoiceMailRecording parameter is only returned if the Voice
Messaging User service is assigned to the user.  This applies to both
users and service instances.

The recordingOption and enableCallRecordingAnnouncement which elements can
only be modified by a System or a Provisioning administrator when
restrictCallRecordingProvisioningAccess system param is set to true. Both the element
values will be ignored when group admin or lower runs this.
The following elements are only used in AS data mode and not returned in XS data mode:
   mediaStream

Attributes:

recording_option (str):

pause_resume_notification (Optional[str]):

enable_call_recording_announcement (Optional[bool]):

enable_record_call_repeat_warning_tone (Optional[bool]):

record_call_repeat_warning_tone_timer_seconds (Optional[int]):

enable_voice_mail_recording (Optional[bool]):

media_stream (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCallRecordingGetResponse23(OCIDataResponse):
    """Response to the UserCallRecordingGetRequest23.
        The response contains the user's Call Recording option information.

        The following parameters are not returned for service instance:
          - pauseResumeNotification
          - enableCallRecordingAnnouncement
          - enableRecordCallRepeatWarningTone
          - recordCallRepeatWarningToneTimerSeconds

        The enableVoiceMailRecording parameter is only returned if the Voice
        Messaging User service is assigned to the user.  This applies to both
        users and service instances.

        The recordingOption and enableCallRecordingAnnouncement which elements can
        only be modified by a System or a Provisioning administrator when
        restrictCallRecordingProvisioningAccess system param is set to true. Both the element
        values will be ignored when group admin or lower runs this.
        The following elements are only used in AS data mode and not returned in XS data mode:
           mediaStream

    Attributes:

        recording_option (str):

        pause_resume_notification (Optional[str]):

        enable_call_recording_announcement (Optional[bool]):

        enable_record_call_repeat_warning_tone (Optional[bool]):

        record_call_repeat_warning_tone_timer_seconds (Optional[int]):

        enable_voice_mail_recording (Optional[bool]):

        media_stream (Optional[str]):

    """

    recording_option: str = field(metadata={"alias": "recordingOption"})

    pause_resume_notification: Optional[str] = field(
        default=None, metadata={"alias": "pauseResumeNotification"}
    )

    enable_call_recording_announcement: Optional[bool] = field(
        default=None, metadata={"alias": "enableCallRecordingAnnouncement"}
    )

    enable_record_call_repeat_warning_tone: Optional[bool] = field(
        default=None, metadata={"alias": "enableRecordCallRepeatWarningTone"}
    )

    record_call_repeat_warning_tone_timer_seconds: Optional[int] = field(
        default=None, metadata={"alias": "recordCallRepeatWarningToneTimerSeconds"}
    )

    enable_voice_mail_recording: Optional[bool] = field(
        default=None, metadata={"alias": "enableVoiceMailRecording"}
    )

    media_stream: Optional[str] = field(default=None, metadata={"alias": "mediaStream"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserCallRecordingGetRequest23

client = Client()

command = UserCallRecordingGetRequest23(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCallRecordingGetRequest23",
    user_id=...,
)

print(response)