GroupFindMeFollowMeGetAlertingGroupRequest

Bases: OCIRequest

Request to get all the information of a Find-me/Follow-me alerting group. The response is either GroupFindMeFollowMeGetAlertingGroupResponse or ErrorResponse.

Attributes:

service_user_id (str):

alerting_group_name (str):

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

@dataclass(kw_only=True)
class GroupFindMeFollowMeGetAlertingGroupRequest(OCIRequest):
    """Request to get all the information of a Find-me/Follow-me alerting group.
        The response is either GroupFindMeFollowMeGetAlertingGroupResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        alerting_group_name (str):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    alerting_group_name: str = field(metadata={"alias": "alertingGroupName"})

Responses

Bases: OCIDataResponse

Response to GroupFindMeFollowMeGetAlertingGroupRequest. Contains the alerting group information. The user table’s column headings are: "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". 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 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) 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. - When no extension is available a blank space is provided instead.

Attributes:

alerting_group_description (Optional[str]):

use_diversion_inhibitor (bool):

answer_confirmation_required (bool):

number_of_rings (int):

phone_number (Optional[List[str]]):

user_table (OCITable):

criteria_table (OCITable):

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

@dataclass(kw_only=True)
class GroupFindMeFollowMeGetAlertingGroupResponse(OCIDataResponse):
    """Response to GroupFindMeFollowMeGetAlertingGroupRequest.
        Contains the alerting group information.
              The user table’s column headings are: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\" and \"Hiragana First Name\", \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".
        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 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)
          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.
          - When no extension is available a blank space is provided instead.

    Attributes:

        alerting_group_description (Optional[str]):

        use_diversion_inhibitor (bool):

        answer_confirmation_required (bool):

        number_of_rings (int):

        phone_number (Optional[List[str]]):

        user_table (OCITable):

        criteria_table (OCITable):

    """

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

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

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

    number_of_rings: int = field(metadata={"alias": "numberOfRings"})

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

    user_table: OCITable = field(metadata={"alias": "userTable"})

    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 GroupFindMeFollowMeGetAlertingGroupRequest

client = Client()

command = GroupFindMeFollowMeGetAlertingGroupRequest(
    service_user_id=...,
    alerting_group_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupFindMeFollowMeGetAlertingGroupRequest",
    service_user_id=...,
    alerting_group_name=...,
)

print(response)