Skip to content

UserBroadWorksAnywhereModifyPhoneNumberRequest

Bases: OCIRequest

Modify a BroadWorks Anywhere phone number

  In XS data mode, the request will fail if the phoneNumber element represents the user's directory number or one of the user's alternate numbers.

  The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

phone_number (str):

new_phone_number (Optional[str]):

description (Optional[Nillable[str]]):

is_active (Optional[bool]):

outbound_alternate_number (Optional[Nillable[str]]):

broadworks_call_control (Optional[bool]):

use_diversion_inhibitor (Optional[bool]):

answer_confirmation_required (Optional[bool]):

criteria_activation (Optional[List[CriteriaActivation]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksAnywhereModifyPhoneNumberRequest(OCIRequest):
    """Modify a BroadWorks Anywhere phone number

          In XS data mode, the request will fail if the phoneNumber element represents the user's directory number or one of the user's alternate numbers.

          The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        phone_number (str):

        new_phone_number (Optional[str]):

        description (Optional[Nillable[str]]):

        is_active (Optional[bool]):

        outbound_alternate_number (Optional[Nillable[str]]):

        broadworks_call_control (Optional[bool]):

        use_diversion_inhibitor (Optional[bool]):

        answer_confirmation_required (Optional[bool]):

        criteria_activation (Optional[List[CriteriaActivation]]):

    """

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

    phone_number: str = field(metadata={"alias": "phoneNumber"})

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

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

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

    outbound_alternate_number: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "outboundAlternateNumber"}
    )

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

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

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

    criteria_activation: Optional[List[CriteriaActivation]] = field(
        default=None, metadata={"alias": "criteriaActivation"}
    )

    def __post_init__(self):
        nillable_fields = ["description", "outbound_alternate_number"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

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 UserBroadWorksAnywhereModifyPhoneNumberRequest

client = Client()

command = UserBroadWorksAnywhereModifyPhoneNumberRequest(
    user_id=...,
    phone_number=...,
    new_phone_number=...,
    description=...,
    is_active=...,
    outbound_alternate_number=...,
    broadworks_call_control=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
    criteria_activation=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksAnywhereModifyPhoneNumberRequest",
    user_id=...,
    phone_number=...,
    new_phone_number=...,
    description=...,
    is_active=...,
    outbound_alternate_number=...,
    broadworks_call_control=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
    criteria_activation=...,
)

print(response)