Skip to content

UserCustomRingbackUserGetCriteriaRequest21

Bases: OCIRequest

Get a criteria for the user's custom ringback service. The response is either a UserCustomRingbackUserGetCriteriaResponse21 or an ErrorResponse.

Attributes:

user_id (str):

criteria_name (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCustomRingbackUserGetCriteriaRequest21(OCIRequest):
    """Get a criteria for the user's custom ringback service.
        The response is either a UserCustomRingbackUserGetCriteriaResponse21 or an ErrorResponse.

    Attributes:

        user_id (str):

        criteria_name (str):

    """

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

    criteria_name: str = field(metadata={"alias": "criteriaName"})

Responses

Bases: OCIDataResponse

Response to the UserCustomRingbackUserGetCriteriaRequest21.

Attributes:

time_schedule (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

blacklisted (bool):

from_dn_criteria (CriteriaFromDn):

call_to_number (Optional[List[CallToNumber]]):

audio_selection (str):

audio_file (Optional[AnnouncementFileLevelKey]):

audio_file_url (Optional[str]):

video_selection (str):

video_file (Optional[AnnouncementFileLevelKey]):

video_file_url (Optional[str]):

call_waiting_audio_selection (Optional[str]):

call_waiting_audio_file (Optional[AnnouncementFileLevelKey]):

call_waiting_audio_file_url (Optional[str]):

call_waiting_video_selection (Optional[str]):

call_waiting_video_file (Optional[AnnouncementFileLevelKey]):

call_waiting_video_file_url (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCustomRingbackUserGetCriteriaResponse21(OCIDataResponse):
    """Response to the UserCustomRingbackUserGetCriteriaRequest21.

    Attributes:

        time_schedule (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        blacklisted (bool):

        from_dn_criteria (CriteriaFromDn):

        call_to_number (Optional[List[CallToNumber]]):

        audio_selection (str):

        audio_file (Optional[AnnouncementFileLevelKey]):

        audio_file_url (Optional[str]):

        video_selection (str):

        video_file (Optional[AnnouncementFileLevelKey]):

        video_file_url (Optional[str]):

        call_waiting_audio_selection (Optional[str]):

        call_waiting_audio_file (Optional[AnnouncementFileLevelKey]):

        call_waiting_audio_file_url (Optional[str]):

        call_waiting_video_selection (Optional[str]):

        call_waiting_video_file (Optional[AnnouncementFileLevelKey]):

        call_waiting_video_file_url (Optional[str]):

    """

    time_schedule: Optional[TimeSchedule] = field(
        default=None, metadata={"alias": "timeSchedule"}
    )

    holiday_schedule: Optional[HolidaySchedule] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

    blacklisted: bool = field(metadata={"alias": "blacklisted"})

    from_dn_criteria: CriteriaFromDn = field(metadata={"alias": "fromDnCriteria"})

    call_to_number: Optional[List[CallToNumber]] = field(
        default=None, metadata={"alias": "callToNumber"}
    )

    audio_selection: str = field(metadata={"alias": "audioSelection"})

    audio_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "audioFile"}
    )

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

    video_selection: str = field(metadata={"alias": "videoSelection"})

    video_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "videoFile"}
    )

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

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

    call_waiting_audio_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "callWaitingAudioFile"}
    )

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

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

    call_waiting_video_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "callWaitingVideoFile"}
    )

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

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 UserCustomRingbackUserGetCriteriaRequest21

client = Client()

command = UserCustomRingbackUserGetCriteriaRequest21(
    user_id=...,
    criteria_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCustomRingbackUserGetCriteriaRequest21",
    user_id=...,
    criteria_name=...,
)

print(response)