Skip to content

UserCallForwardingSelectiveAddCriteriaRequest16

Bases: OCIRequest

Add a criteria to the user's call forwarding selective service. The following elements are only used in AS data mode: callToNumber

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

forward_to_number_selection (Optional[str]):

forward_to_phone_number (Optional[str]):

from_dn_criteria (CriteriaFromDn):

call_to_number (Optional[List[CallToNumber]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserCallForwardingSelectiveAddCriteriaRequest16(OCIRequest):
    """Add a criteria to the user's call forwarding selective service.
        The following elements are only used in AS data mode:
          callToNumber

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

        forward_to_number_selection (Optional[str]):

        forward_to_phone_number (Optional[str]):

        from_dn_criteria (CriteriaFromDn):

        call_to_number (Optional[List[CallToNumber]]):

    """

    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"}
    )

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

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

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

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

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 UserCallForwardingSelectiveAddCriteriaRequest16

client = Client()

command = UserCallForwardingSelectiveAddCriteriaRequest16(
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    forward_to_number_selection=...,
    forward_to_phone_number=...,
    from_dn_criteria=...,
    call_to_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallForwardingSelectiveAddCriteriaRequest16",
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    forward_to_number_selection=...,
    forward_to_phone_number=...,
    from_dn_criteria=...,
    call_to_number=...,
)

print(response)