UserPushToTalkGetRequest

Bases: OCIRequest

Request the push to talk service setting. The response is either a UserPushToTalkGetResponse or an ErrorResponse.

Attributes:

user_id (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserPushToTalkGetRequest(OCIRequest):
    """Request the push to talk service setting.
        The response is either a UserPushToTalkGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserPushToTalkGetRequest. It returns the service settings and a 9 column selected user table with the following column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "IMP Id".

Attributes:

allow_auto_answer (bool):

outgoing_connection_selection (str):

access_list_selection (str):

selected_user_table (OCITable):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserPushToTalkGetResponse(OCIDataResponse):
    """Response to UserPushToTalkGetRequest.  It returns the service settings and a
        9 column selected user table with the following column headings:
          \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
          \"Phone Number\", \"Extension\", \"Department\", \"Email Address\", \"IMP Id\".

    Attributes:

        allow_auto_answer (bool):

        outgoing_connection_selection (str):

        access_list_selection (str):

        selected_user_table (OCITable):

    """

    allow_auto_answer: bool = field(metadata={"alias": "allowAutoAnswer"})

    outgoing_connection_selection: str = field(
        metadata={"alias": "outgoingConnectionSelection"}
    )

    access_list_selection: str = field(metadata={"alias": "accessListSelection"})

    selected_user_table: OCITable = field(metadata={"alias": "selectedUserTable"})

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 UserPushToTalkGetRequest

client = Client()

command = UserPushToTalkGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPushToTalkGetRequest",
    user_id=...,
)

print(response)