Skip to content

UserCustomRingbackUserAddCriteriaRequest20

Bases: OCIRequest

Add a criteria to the user's custom ringback service. For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

criteria_name (str):

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[ExtendedMediaFileLevelResource20]):

video_selection (str):

video_file (Optional[ExtendedMediaFileLevelResource20]):

call_waiting_audio_selection (Optional[str]):

call_waiting_audio_file (Optional[ExtendedMediaFileLevelResource20]):

call_waiting_video_selection (Optional[str]):

call_waiting_video_file (Optional[ExtendedMediaFileLevelResource20]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCustomRingbackUserAddCriteriaRequest20(OCIRequest):
    """Add a criteria to the user's custom ringback service.
        For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        criteria_name (str):

        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[ExtendedMediaFileLevelResource20]):

        video_selection (str):

        video_file (Optional[ExtendedMediaFileLevelResource20]):

        call_waiting_audio_selection (Optional[str]):

        call_waiting_audio_file (Optional[ExtendedMediaFileLevelResource20]):

        call_waiting_video_selection (Optional[str]):

        call_waiting_video_file (Optional[ExtendedMediaFileLevelResource20]):

    """

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

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

    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[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "audioFile"}
    )

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

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

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

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

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

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

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 UserCustomRingbackUserAddCriteriaRequest20

client = Client()

command = UserCustomRingbackUserAddCriteriaRequest20(
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    blacklisted=...,
    from_dn_criteria=...,
    call_to_number=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
    call_waiting_audio_selection=...,
    call_waiting_audio_file=...,
    call_waiting_video_selection=...,
    call_waiting_video_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCustomRingbackUserAddCriteriaRequest20",
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    blacklisted=...,
    from_dn_criteria=...,
    call_to_number=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
    call_waiting_audio_selection=...,
    call_waiting_audio_file=...,
    call_waiting_video_selection=...,
    call_waiting_video_file=...,
)

print(response)