UserCallRecordingModifyRequest

Bases: OCIRequest

Modify the Call Recording attributes for a user. The recording options "Always with Pause/Resume", "On Demand", and "On Demand with User Initiated Start" are not accepted for service instances.

The response is either a SuccessResponse or an ErrorResponse.

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

The enableVoiceMailRecording parameter is only applicable if the Voice Messaging User service is assigned to the user. This applies to both users and service instances. The following elements are only used in AS data mode and ignored in XS data mode: mediaStream

Attributes:

user_id (str):

recording_option (Optional[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/commands/commands.py

@dataclass(kw_only=True)
class UserCallRecordingModifyRequest(OCIRequest):
    """Modify the Call Recording attributes for a user. The recording options
       \"Always with Pause/Resume\", \"On Demand\", and \"On Demand with User
       Initiated Start\" are not accepted for service instances.

       The response is either a SuccessResponse or an ErrorResponse.

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

       The enableVoiceMailRecording parameter is only applicable
       if the Voice Messaging User service is assigned to the user.
       This applies to both users and service instances.
       The following elements are only used in AS data mode and ignored in XS data mode:
         mediaStream

    Attributes:

        user_id (str):

        recording_option (Optional[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]):

    """

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

    recording_option: Optional[str] = field(
        default=None, 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"})

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserCallRecordingModifyRequest

client = Client()

command = UserCallRecordingModifyRequest(
    user_id=...,
    recording_option=...,
    pause_resume_notification=...,
    enable_call_recording_announcement=...,
    enable_record_call_repeat_warning_tone=...,
    record_call_repeat_warning_tone_timer_seconds=...,
    enable_voice_mail_recording=...,
    media_stream=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallRecordingModifyRequest",
    user_id=...,
    recording_option=...,
    pause_resume_notification=...,
    enable_call_recording_announcement=...,
    enable_record_call_repeat_warning_tone=...,
    record_call_repeat_warning_tone_timer_seconds=...,
    enable_voice_mail_recording=...,
    media_stream=...,
)

print(response)