Skip to content

UserAddRequest22V2

Bases: OCIRequest

Request to add a user. The domain is required in the userId. The password is not required if external authentication is enabled.

The following elements are only used in AS data mode and will fail in XS data mode:
  trunkAddressing
The following elements are only used in AS data mode and ignored in XS data mode:
  nameDialingName
  alternateUserId
  isPlace

The following elements are only used in XS data mode and ignored in AS data mode:
  allowVideo

The response is either SuccessResponse or ErrorResponse.

The following elements can only be used by a system administrator:.
  allowVideo

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

user_id (str):

last_name (str):

first_name (str):

calling_line_id_last_name (str):

calling_line_id_first_name (str):

name_dialing_name (Optional[NameDialingName]):

hiragana_last_name (Optional[str]):

hiragana_first_name (Optional[str]):

phone_number (Optional[str]):

extension (Optional[str]):

calling_line_id_phone_number (Optional[str]):

password (Optional[str]):

department (Optional[DepartmentKey]):

language (Optional[str]):

time_zone (Optional[str]):

alias (Optional[List[str]]):

access_device_endpoint (Optional[AccessDeviceMultipleIdentityAndContactEndpointAdd22V2]):

trunk_addressing (Optional[TrunkAddressingMultipleContactAdd22]):

title (Optional[str]):

pager_phone_number (Optional[str]):

mobile_phone_number (Optional[str]):

email_address (Optional[str]):

yahoo_id (Optional[str]):

address_location (Optional[str]):

address (Optional[StreetAddress]):

network_class_of_service (Optional[str]):

alternate_user_id (Optional[List[AlternateUserIdEntry]]):

is_place (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserAddRequest22V2(OCIRequest):
    """Request to add a user.
        The domain is required in the userId.
        The password is not required if external authentication is enabled.

        The following elements are only used in AS data mode and will fail in XS data mode:
          trunkAddressing
        The following elements are only used in AS data mode and ignored in XS data mode:
          nameDialingName
          alternateUserId
          isPlace

        The following elements are only used in XS data mode and ignored in AS data mode:
          allowVideo

        The response is either SuccessResponse or ErrorResponse.

        The following elements can only be used by a system administrator:.
          allowVideo

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        user_id (str):

        last_name (str):

        first_name (str):

        calling_line_id_last_name (str):

        calling_line_id_first_name (str):

        name_dialing_name (Optional[NameDialingName]):

        hiragana_last_name (Optional[str]):

        hiragana_first_name (Optional[str]):

        phone_number (Optional[str]):

        extension (Optional[str]):

        calling_line_id_phone_number (Optional[str]):

        password (Optional[str]):

        department (Optional[DepartmentKey]):

        language (Optional[str]):

        time_zone (Optional[str]):

        alias (Optional[List[str]]):

        access_device_endpoint (Optional[AccessDeviceMultipleIdentityAndContactEndpointAdd22V2]):

        trunk_addressing (Optional[TrunkAddressingMultipleContactAdd22]):

        title (Optional[str]):

        pager_phone_number (Optional[str]):

        mobile_phone_number (Optional[str]):

        email_address (Optional[str]):

        yahoo_id (Optional[str]):

        address_location (Optional[str]):

        address (Optional[StreetAddress]):

        network_class_of_service (Optional[str]):

        alternate_user_id (Optional[List[AlternateUserIdEntry]]):

        is_place (Optional[bool]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

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

    last_name: str = field(metadata={"alias": "lastName"})

    first_name: str = field(metadata={"alias": "firstName"})

    calling_line_id_last_name: str = field(metadata={"alias": "callingLineIdLastName"})

    calling_line_id_first_name: str = field(
        metadata={"alias": "callingLineIdFirstName"}
    )

    name_dialing_name: Optional[NameDialingName] = field(
        default=None, metadata={"alias": "nameDialingName"}
    )

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

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

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

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

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

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

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

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

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

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

    access_device_endpoint: Optional[
        AccessDeviceMultipleIdentityAndContactEndpointAdd22V2
    ] = field(default=None, metadata={"alias": "accessDeviceEndpoint"})

    trunk_addressing: Optional[TrunkAddressingMultipleContactAdd22] = field(
        default=None, metadata={"alias": "trunkAddressing"}
    )

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

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

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

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

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

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

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

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

    alternate_user_id: Optional[List[AlternateUserIdEntry]] = field(
        default=None, metadata={"alias": "alternateUserId"}
    )

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

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

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 UserAddRequest22V2

client = Client()

command = UserAddRequest22V2(
    service_provider_id=...,
    group_id=...,
    user_id=...,
    last_name=...,
    first_name=...,
    calling_line_id_last_name=...,
    calling_line_id_first_name=...,
    name_dialing_name=...,
    hiragana_last_name=...,
    hiragana_first_name=...,
    phone_number=...,
    extension=...,
    calling_line_id_phone_number=...,
    password=...,
    department=...,
    language=...,
    time_zone=...,
    alias=...,
    access_device_endpoint=...,
    trunk_addressing=...,
    title=...,
    pager_phone_number=...,
    mobile_phone_number=...,
    email_address=...,
    yahoo_id=...,
    address_location=...,
    address=...,
    network_class_of_service=...,
    alternate_user_id=...,
    is_place=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserAddRequest22V2",
    service_provider_id=...,
    group_id=...,
    user_id=...,
    last_name=...,
    first_name=...,
    calling_line_id_last_name=...,
    calling_line_id_first_name=...,
    name_dialing_name=...,
    hiragana_last_name=...,
    hiragana_first_name=...,
    phone_number=...,
    extension=...,
    calling_line_id_phone_number=...,
    password=...,
    department=...,
    language=...,
    time_zone=...,
    alias=...,
    access_device_endpoint=...,
    trunk_addressing=...,
    title=...,
    pager_phone_number=...,
    mobile_phone_number=...,
    email_address=...,
    yahoo_id=...,
    address_location=...,
    address=...,
    network_class_of_service=...,
    alternate_user_id=...,
    is_place=...,
)

print(response)