Skip to content

GroupUserCallForwardingSettingsGetListRequest

Bases: OCIRequest

Get a list of users and the service settings for a Call Forwarding service. The response is either GroupUserCallForwardingSettingsGetListResponse or ErrorResponse. By default, virtual users and non-virtual users that match the selected search criteria are included in the response when "includeVirtualUsers" is present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users are returned. The search can be performed using multiple criteria. If search criteria is specified, only the users matching all of the specified search criteria are included in the response. If no search criteria is specified, all results are returned.

Attributes:

service_provider_id (str):

group_id (str):

call_forwarding_service (str):

response_paging_control (ResponsePagingControl):

sort_by_user_last_name (Optional[SortByUserLastName]):

sort_by_user_first_name (Optional[SortByUserFirstName]):

sort_by_user_department (Optional[SortByUserDepartment]):

sort_by_dn (Optional[SortByDn]):

sort_by_extension (Optional[SortByExtension]):

sort_by_forwarded_to_number (Optional[SortByForwardedToNumber]):

include_virtual_users (Optional[bool]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):

search_criteria_forwarded_to_number (Optional[List[SearchCriteriaForwardedToNumber]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupUserCallForwardingSettingsGetListRequest(OCIRequest):
    """Get a list of users and the service settings for a Call Forwarding service.
        The response is either GroupUserCallForwardingSettingsGetListResponse or ErrorResponse.
        By default, virtual users and non-virtual users that match the selected search criteria are included in the response when \"includeVirtualUsers\" is present; otherwise, if \"includeVirtualUsers\" is absent, then only non-virtual users are returned.
        The search can be performed using multiple criteria. If search criteria is specified, only the users matching all of the specified search criteria are included in the response. If no search criteria is specified, all results are returned.

    Attributes:

        service_provider_id (str):

        group_id (str):

        call_forwarding_service (str):

        response_paging_control (ResponsePagingControl):

        sort_by_user_last_name (Optional[SortByUserLastName]):

        sort_by_user_first_name (Optional[SortByUserFirstName]):

        sort_by_user_department (Optional[SortByUserDepartment]):

        sort_by_dn (Optional[SortByDn]):

        sort_by_extension (Optional[SortByExtension]):

        sort_by_forwarded_to_number (Optional[SortByForwardedToNumber]):

        include_virtual_users (Optional[bool]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):

        search_criteria_forwarded_to_number (Optional[List[SearchCriteriaForwardedToNumber]]):

    """

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

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

    call_forwarding_service: str = field(metadata={"alias": "callForwardingService"})

    response_paging_control: ResponsePagingControl = field(
        metadata={"alias": "responsePagingControl"}
    )

    sort_by_user_last_name: Optional[SortByUserLastName] = field(
        default=None, metadata={"alias": "sortByUserLastName"}
    )

    sort_by_user_first_name: Optional[SortByUserFirstName] = field(
        default=None, metadata={"alias": "sortByUserFirstName"}
    )

    sort_by_user_department: Optional[SortByUserDepartment] = field(
        default=None, metadata={"alias": "sortByUserDepartment"}
    )

    sort_by_dn: Optional[SortByDn] = field(default=None, metadata={"alias": "sortByDn"})

    sort_by_extension: Optional[SortByExtension] = field(
        default=None, metadata={"alias": "sortByExtension"}
    )

    sort_by_forwarded_to_number: Optional[SortByForwardedToNumber] = field(
        default=None, metadata={"alias": "sortByForwardedToNumber"}
    )

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

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

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

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

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

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

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

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_exact_user_in_trunk_group: Optional[
        SearchCriteriaExactUserInTrunkGroup
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserInTrunkGroup"})

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

Responses

Bases: OCIDataResponse

Response to the GroupUserCallForwardingSettingsGetListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name", "Phone Number", "Extension", "Department", "In Trunk Group", "Email Address", "Is Active", "Forwarding Address". "Is Active" is "true" or "false". The "Forwarding Address" is the Call Forwarding service's forwarding address. If the service is Call Forwarding Selective, the default forwarding address is returned. "Phone Number" is presented in the E164 format.

Attributes:

user_call_forwarding_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupUserCallForwardingSettingsGetListResponse(OCIDataResponse):
    """Response to the GroupUserCallForwardingSettingsGetListRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\", \"First Name\",
        \"Hiragana Last Name\", and \"Hiragana First Name\", \"Phone Number\",
        \"Extension\", \"Department\", \"In Trunk Group\", \"Email Address\",
        \"Is Active\", \"Forwarding Address\".
        \"Is Active\" is \"true\" or \"false\".
        The \"Forwarding Address\" is the Call Forwarding service's forwarding address.
        If the service is Call Forwarding Selective, the default forwarding address is returned.
        \"Phone Number\" is presented in the E164 format.

    Attributes:

        user_call_forwarding_table (OCITable):

    """

    user_call_forwarding_table: OCITable = field(
        metadata={"alias": "userCallForwardingTable"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupUserCallForwardingSettingsGetListRequest

client = Client()

command = GroupUserCallForwardingSettingsGetListRequest(
    service_provider_id=...,
    group_id=...,
    call_forwarding_service=...,
    response_paging_control=...,
    sort_by_user_last_name=...,
    sort_by_user_first_name=...,
    sort_by_user_department=...,
    sort_by_dn=...,
    sort_by_extension=...,
    sort_by_forwarded_to_number=...,
    include_virtual_users=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_in_trunk_group=...,
    search_criteria_forwarded_to_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupUserCallForwardingSettingsGetListRequest",
    service_provider_id=...,
    group_id=...,
    call_forwarding_service=...,
    response_paging_control=...,
    sort_by_user_last_name=...,
    sort_by_user_first_name=...,
    sort_by_user_department=...,
    sort_by_dn=...,
    sort_by_extension=...,
    sort_by_forwarded_to_number=...,
    include_virtual_users=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_email_address=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_in_trunk_group=...,
    search_criteria_forwarded_to_number=...,
)

print(response)