Skip to content

UserBroadWorksAnywhereAddPhoneNumberRequest

Bases: OCIRequest

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

description (Optional[str]):

is_active (bool):

outbound_alternate_number (Optional[str]):

broadworks_call_control (bool):

use_diversion_inhibitor (bool):

answer_confirmation_required (bool):
Source code in src/mercury_ocip/commands/commands.py 
100806
100807
100808
100809
100810
100811
100812
100813
100814
100815
100816
100817
100818
100819
100820
100821
100822
100823
100824
100825
100826
100827
100828
100829
100830
100831
100832
100833
100834
100835
100836
100837
100838
100839
100840
100841
100842
100843
100844
100845
100846
100847
100848
100849
100850
100851
100852
@dataclass(kw_only=True)
class UserBroadWorksAnywhereAddPhoneNumberRequest(OCIRequest):
    """Add 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):

        description (Optional[str]):

        is_active (bool):

        outbound_alternate_number (Optional[str]):

        broadworks_call_control (bool):

        use_diversion_inhibitor (bool):

        answer_confirmation_required (bool):

    """

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

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

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

    is_active: bool = field(metadata={"alias": "isActive"})

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

    broadworks_call_control: bool = field(metadata={"alias": "broadworksCallControl"})

    use_diversion_inhibitor: bool = field(metadata={"alias": "useDiversionInhibitor"})

    answer_confirmation_required: bool = field(
        metadata={"alias": "answerConfirmationRequired"}
    )

Responses

Bases: OCIResponse

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

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
115
116
117
118
119
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 UserBroadWorksAnywhereAddPhoneNumberRequest

client = Client()

command = UserBroadWorksAnywhereAddPhoneNumberRequest(
    user_id=...,
    phone_number=...,
    description=...,
    is_active=...,
    outbound_alternate_number=...,
    broadworks_call_control=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

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

print(response)