UserCallNotifyGetRequest

Bases: OCIRequest

Get the user's call notify service setting. The response is either a UserCallNotifyGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserCallNotifyGetRequest(OCIRequest):
    """Get the user's call notify service setting.
        The response is either a UserCallNotifyGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserCallNotifyGetRequest. The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted" ,"Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". The following columns are only returned in AS data mode: "Calls To Type", "Calls To Number" and "Calls To Extension"

The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:
  - Primary
  - Alternate X (where x is a number between 1 and 10)
  - Mobility
The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:
  - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number.
  - When no number is available a blank space is provided instead.
The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:
  - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension.
  - For Mobility Calls To Type, this is always blank.
  - When no extension is available a blank space is provided instead.

Attributes:

call_notify_email_address (Optional[str]):

criteria_table (OCITable):

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

@dataclass(kw_only=True)
class UserCallNotifyGetResponse(OCIDataResponse):
    """Response to the UserCallNotifyGetRequest. The criteria table's column headings are: \"Is Active\",
        \"Criteria Name\", \"Time Schedule\", \"Calls From\", \"Blacklisted\" ,\"Holiday Schedule\", \"Calls To Type\", \"Calls To Number\" and \"Calls To Extension\".
        The following columns are only returned in AS data mode:
          \"Calls To Type\", \"Calls To Number\" and \"Calls To Extension\"

        The possible values for the \"Calls To Type\" column are the following or a combination of them separated by comma:
          - Primary
          - Alternate X (where x is a number between 1 and 10)
          - Mobility
        The possible values for the \"Calls To Number\" column are the following or a combination of them separated by comma:
          - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number.
          - When no number is available a blank space is provided instead.
        The possible values for the \"Calls To Extension\" column are the following or a combination of them separated by comma:
          - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension.
          - For Mobility Calls To Type, this is always blank.
          - When no extension is available a blank space is provided instead.

    Attributes:

        call_notify_email_address (Optional[str]):

        criteria_table (OCITable):

    """

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

    criteria_table: OCITable = field(metadata={"alias": "criteriaTable"})

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 UserCallNotifyGetRequest

client = Client()

command = UserCallNotifyGetRequest(
    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("UserCallNotifyGetRequest",
    user_id=...,
)

print(response)