Skip to content

UserPreAlertingAnnouncementGetRequest20

Bases: OCIRequest

Get the user's pre-alerting service setting. The response is either a UserPreAlertingAnnouncementGetResponse20 or an ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPreAlertingAnnouncementGetRequest20(OCIRequest):
    """Get the user's pre-alerting service setting.
        The response is either a UserPreAlertingAnnouncementGetResponse20 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to a UserPreAlertingAnnouncementGetRequest20. The criteria table's column headings are: "Is Active", "Criteria Name", "Blacklisted", "Calls From", "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:

is_active (bool):

audio_selection (str):

audio_file (Optional[AnnouncementFileLevelKey]):

audio_file_url (Optional[str]):

video_selection (str):

video_file (Optional[AnnouncementFileLevelKey]):

video_file_url (Optional[str]):

criteria_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPreAlertingAnnouncementGetResponse20(OCIDataResponse):
    """Response to a UserPreAlertingAnnouncementGetRequest20.
         The criteria table's column headings are: \"Is Active\", \"Criteria Name\", \"Blacklisted\", \"Calls From\", \"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:

        is_active (bool):

        audio_selection (str):

        audio_file (Optional[AnnouncementFileLevelKey]):

        audio_file_url (Optional[str]):

        video_selection (str):

        video_file (Optional[AnnouncementFileLevelKey]):

        video_file_url (Optional[str]):

        criteria_table (OCITable):

    """

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

    audio_selection: str = field(metadata={"alias": "audioSelection"})

    audio_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "audioFile"}
    )

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

    video_selection: str = field(metadata={"alias": "videoSelection"})

    video_file: Optional[AnnouncementFileLevelKey] = field(
        default=None, metadata={"alias": "videoFile"}
    )

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

    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 UserPreAlertingAnnouncementGetRequest20

client = Client()

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

print(response)