Skip to content

UserRouteListGetRequest24

Bases: OCIRequest

Get the route list setting and the list of number ranges assigned to a user. The response is either UserRouteListGetResponse24 or ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserRouteListGetRequest24(OCIRequest):
    """Get the route list setting and the list of number ranges assigned to a user.
        The response is either UserRouteListGetResponse24 or ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserRouteListGetRequest24. Contains the route list setting and a list of assigned number ranges and number prefixes. The column headings for assignedNumberRangeTable are "Number Range Start", "Number Range End", "Is Active" and "Extension Length". The column headings for assignedNumberPrefixTable are "Number Prefix" ","Is Active", "Extension Range Start" and "Extension Range End".

Attributes:

treat_originations_and_pbx_redirections_as_screened (bool):

use_route_list_identity_for_non_emergency_calls (bool):

use_route_list_identity_for_emergency_calls (bool):

ignore_calling_name_for_call_processing (bool):

assigned_number_range_table (OCITable):

assigned_number_prefix_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserRouteListGetResponse24(OCIDataResponse):
    """Response to UserRouteListGetRequest24.
        Contains the route list setting and a list of assigned number ranges and number prefixes.
        The column headings for assignedNumberRangeTable are \"Number Range Start\", \"Number Range End\", \"Is Active\" and \"Extension Length\".
        The column headings for assignedNumberPrefixTable are \"Number Prefix\" \",\"Is Active\", \"Extension Range Start\" and \"Extension Range End\".

    Attributes:

        treat_originations_and_pbx_redirections_as_screened (bool):

        use_route_list_identity_for_non_emergency_calls (bool):

        use_route_list_identity_for_emergency_calls (bool):

        ignore_calling_name_for_call_processing (bool):

        assigned_number_range_table (OCITable):

        assigned_number_prefix_table (OCITable):

    """

    treat_originations_and_pbx_redirections_as_screened: bool = field(
        metadata={"alias": "treatOriginationsAndPBXRedirectionsAsScreened"}
    )

    use_route_list_identity_for_non_emergency_calls: bool = field(
        metadata={"alias": "useRouteListIdentityForNonEmergencyCalls"}
    )

    use_route_list_identity_for_emergency_calls: bool = field(
        metadata={"alias": "useRouteListIdentityForEmergencyCalls"}
    )

    ignore_calling_name_for_call_processing: bool = field(
        metadata={"alias": "ignoreCallingNameForCallProcessing"}
    )

    assigned_number_range_table: OCITable = field(
        metadata={"alias": "assignedNumberRangeTable"}
    )

    assigned_number_prefix_table: OCITable = field(
        metadata={"alias": "assignedNumberPrefixTable"}
    )

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 UserRouteListGetRequest24

client = Client()

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

print(response)