UserExternalCustomRingbackGetRequest

Bases: OCIRequest

Request the user level data associated with External Custom Ringback. The response is either a UserExternalCustomRingbackGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserExternalCustomRingbackGetRequest(OCIRequest):
    """Request the user level data associated with External Custom Ringback.
        The response is either a UserExternalCustomRingbackGetResponse or an
        ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserExternalCustomRingbackGetRequest.

Attributes:

is_active (bool):

use_setting_level (str):

sip_request_uri (Optional[str]):

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

@dataclass(kw_only=True)
class UserExternalCustomRingbackGetResponse(OCIDataResponse):
    """Response to UserExternalCustomRingbackGetRequest.

    Attributes:

        is_active (bool):

        use_setting_level (str):

        sip_request_uri (Optional[str]):

    """

    is_active: bool = field(metadata={"alias": "isActive"})

    use_setting_level: str = field(metadata={"alias": "useSettingLevel"})

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

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 UserExternalCustomRingbackGetRequest

client = Client()

command = UserExternalCustomRingbackGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserExternalCustomRingbackGetRequest",
    user_id=...,
)

print(response)