Skip to content

UserEnhancedCallLogsGetListRequest23

Bases: OCIRequest

Request user's call logs. If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned. The response is either a UserEnhancedCallLogsGetListResponse23 or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: callAuthorizationCodeFilter

Attributes:

user_id (str):

call_log_type (Optional[str]):

date_time_range (EnhancedCallLogsTimeRange):

number_filter (Optional[EnhancedCallLogsNumberFilter]):

redirected_number_filter (Optional[EnhancedCallLogsRedirectedNumberFilter23]):

account_authorization_code_filter (Optional[EnhancedCallLogsAccountAuthorizationCodeFilter]):

call_authorization_code_filter (Optional[EnhancedCallLogsCallAuthorizationCodeFilter]):

subscriber_type (Optional[str]):

response_paging_control (Optional[ResponsePagingControl]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserEnhancedCallLogsGetListRequest23(OCIRequest):
    """Request user's call logs.
        If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned.
        The filters \"dateTimeRange\", \"numberFilter\", \"redirectedNumberFilter\", \"accountAuthorizationCodeFilter\"
        \"callAuthorizationCodeFilter\" and \"subscriberType\" are ignored if call logs are stored in CDS. When
        \"ReceivedOrMissed\" is specified as \"callLogType\" and call logs are stored in CDS, all call logs including
        placed will be returned.
        It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl
        is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control
        the maximum number of call logs can be returned.
        The response is either a UserEnhancedCallLogsGetListResponse23 or an ErrorResponse.
        The following elements are only used in AS data mode and ignored in XS data mode:
          callAuthorizationCodeFilter

    Attributes:

        user_id (str):

        call_log_type (Optional[str]):

        date_time_range (EnhancedCallLogsTimeRange):

        number_filter (Optional[EnhancedCallLogsNumberFilter]):

        redirected_number_filter (Optional[EnhancedCallLogsRedirectedNumberFilter23]):

        account_authorization_code_filter (Optional[EnhancedCallLogsAccountAuthorizationCodeFilter]):

        call_authorization_code_filter (Optional[EnhancedCallLogsCallAuthorizationCodeFilter]):

        subscriber_type (Optional[str]):

        response_paging_control (Optional[ResponsePagingControl]):

    """

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

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

    date_time_range: EnhancedCallLogsTimeRange = field(
        metadata={"alias": "dateTimeRange"}
    )

    number_filter: Optional[EnhancedCallLogsNumberFilter] = field(
        default=None, metadata={"alias": "numberFilter"}
    )

    redirected_number_filter: Optional[EnhancedCallLogsRedirectedNumberFilter23] = (
        field(default=None, metadata={"alias": "redirectedNumberFilter"})
    )

    account_authorization_code_filter: Optional[
        EnhancedCallLogsAccountAuthorizationCodeFilter
    ] = field(default=None, metadata={"alias": "accountAuthorizationCodeFilter"})

    call_authorization_code_filter: Optional[
        EnhancedCallLogsCallAuthorizationCodeFilter
    ] = field(default=None, metadata={"alias": "callAuthorizationCodeFilter"})

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

Responses

Bases: OCIDataResponse

Response to UserEnhancedCallLogsGetListRequest23. Total numbers of rows is: - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest22, if a call log type was specified in the request. - the total number of retrievable logs, if no call log type was specified in the request. A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry22 will be returned if the call logs are stored on DBS or Couchbase The logs are sorted by date/time of the call.

Attributes:

total_number_of_rows (int):

legacy_entry (Optional[object]):

extended_entry (Optional[object]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserEnhancedCallLogsGetListResponse23(OCIDataResponse):
    """Response to UserEnhancedCallLogsGetListRequest23.
        Total numbers of rows is:
        - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest22,
          if a call log type was specified in the request.
        - the total number of retrievable logs, if no call log type was specified in the request.
        A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS
        A list of ExtendedMixedCallLogsEntry22 will be returned if the call logs are stored on DBS or Couchbase
        The logs are sorted by date/time of the call.

    Attributes:

        total_number_of_rows (int):

        legacy_entry (Optional[object]):

        extended_entry (Optional[object]):

    """

    total_number_of_rows: int = field(metadata={"alias": "totalNumberOfRows"})

    legacy_entry: Optional[object] = field(
        default=None, metadata={"alias": "legacyEntry"}
    )

    extended_entry: Optional[object] = field(
        default=None, metadata={"alias": "extendedEntry"}
    )

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 UserEnhancedCallLogsGetListRequest23

client = Client()

command = UserEnhancedCallLogsGetListRequest23(
    user_id=...,
    call_log_type=...,
    date_time_range=...,
    number_filter=...,
    redirected_number_filter=...,
    account_authorization_code_filter=...,
    call_authorization_code_filter=...,
    subscriber_type=...,
    response_paging_control=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserEnhancedCallLogsGetListRequest23",
    user_id=...,
    call_log_type=...,
    date_time_range=...,
    number_filter=...,
    redirected_number_filter=...,
    account_authorization_code_filter=...,
    call_authorization_code_filter=...,
    subscriber_type=...,
    response_paging_control=...,
)

print(response)