UserCallPoliciesModifyRequest

Bases: OCIRequest

Modify the user level data associated with Call Policies. The following elements are only used in AS data mode: callingLineIdentityForRedirectedCalls

The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

redirected_calls_colp_privacy (Optional[str]):

call_being_forwarded_response_call_type (Optional[str]):

calling_line_identity_for_redirected_calls (Optional[str]):

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

@dataclass(kw_only=True)
class UserCallPoliciesModifyRequest(OCIRequest):
    """Modify the user level data associated with Call Policies.
        The following elements are only used in AS data mode:
          callingLineIdentityForRedirectedCalls

        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        redirected_calls_colp_privacy (Optional[str]):

        call_being_forwarded_response_call_type (Optional[str]):

        calling_line_identity_for_redirected_calls (Optional[str]):

    """

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

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

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

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

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 UserCallPoliciesModifyRequest

client = Client()

command = UserCallPoliciesModifyRequest(
    user_id=...,
    redirected_calls_colp_privacy=...,
    call_being_forwarded_response_call_type=...,
    calling_line_identity_for_redirected_calls=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCallPoliciesModifyRequest",
    user_id=...,
    redirected_calls_colp_privacy=...,
    call_being_forwarded_response_call_type=...,
    calling_line_identity_for_redirected_calls=...,
)

print(response)