Skip to content

UserAlternateNumbersModifyRequest

Bases: OCIRequest

Modify the user level data associated with Alternate Numbers. The following element in AlternateNumberEntry21 datatype is only used in AS mode: description

In XS data mode, the request will fail if one of the alternate entry's phone number element represents a currently configured BroadWorks Anywhere location for the user.

The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

distinctive_ring (Optional[bool]):

alternate_entry01 (Optional[AlternateNumberEntry21]):

alternate_entry02 (Optional[AlternateNumberEntry21]):

alternate_entry03 (Optional[AlternateNumberEntry21]):

alternate_entry04 (Optional[AlternateNumberEntry21]):

alternate_entry05 (Optional[AlternateNumberEntry21]):

alternate_entry06 (Optional[AlternateNumberEntry21]):

alternate_entry07 (Optional[AlternateNumberEntry21]):

alternate_entry08 (Optional[AlternateNumberEntry21]):

alternate_entry09 (Optional[AlternateNumberEntry21]):

alternate_entry10 (Optional[AlternateNumberEntry21]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserAlternateNumbersModifyRequest(OCIRequest):
    """Modify the user level data associated with Alternate Numbers.
        The following element in AlternateNumberEntry21 datatype is only used in AS mode:
          description

        In XS data mode, the request will fail if one of the alternate entry's phone number element represents a currently configured BroadWorks Anywhere location for the user.

        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        distinctive_ring (Optional[bool]):

        alternate_entry01 (Optional[AlternateNumberEntry21]):

        alternate_entry02 (Optional[AlternateNumberEntry21]):

        alternate_entry03 (Optional[AlternateNumberEntry21]):

        alternate_entry04 (Optional[AlternateNumberEntry21]):

        alternate_entry05 (Optional[AlternateNumberEntry21]):

        alternate_entry06 (Optional[AlternateNumberEntry21]):

        alternate_entry07 (Optional[AlternateNumberEntry21]):

        alternate_entry08 (Optional[AlternateNumberEntry21]):

        alternate_entry09 (Optional[AlternateNumberEntry21]):

        alternate_entry10 (Optional[AlternateNumberEntry21]):

    """

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

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

    alternate_entry01: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry01"}
    )

    alternate_entry02: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry02"}
    )

    alternate_entry03: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry03"}
    )

    alternate_entry04: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry04"}
    )

    alternate_entry05: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry05"}
    )

    alternate_entry06: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry06"}
    )

    alternate_entry07: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry07"}
    )

    alternate_entry08: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry08"}
    )

    alternate_entry09: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry09"}
    )

    alternate_entry10: Optional[AlternateNumberEntry21] = field(
        default=None, metadata={"alias": "alternateEntry10"}
    )

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 UserAlternateNumbersModifyRequest

client = Client()

command = UserAlternateNumbersModifyRequest(
    user_id=...,
    distinctive_ring=...,
    alternate_entry01=...,
    alternate_entry02=...,
    alternate_entry03=...,
    alternate_entry04=...,
    alternate_entry05=...,
    alternate_entry06=...,
    alternate_entry07=...,
    alternate_entry08=...,
    alternate_entry09=...,
    alternate_entry10=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserAlternateNumbersModifyRequest",
    user_id=...,
    distinctive_ring=...,
    alternate_entry01=...,
    alternate_entry02=...,
    alternate_entry03=...,
    alternate_entry04=...,
    alternate_entry05=...,
    alternate_entry06=...,
    alternate_entry07=...,
    alternate_entry08=...,
    alternate_entry09=...,
    alternate_entry10=...,
)

print(response)