UserMusicOnHoldUserGetRequest20

Bases: OCIRequest

Request the user level data associated with Music On Hold User. The response is either a UserMusicOnHoldUserGetResponse20 or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserMusicOnHoldUserGetRequest20(OCIRequest):
    """Request the user level data associated with Music On Hold User.
        The response is either a UserMusicOnHoldUserGetResponse20 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserMusicOnHoldUserGetRequest20.

Attributes:

enable_video (bool):

source (MusicOnHoldUserSourceRead20):

use_alternate_source_for_internal_calls (bool):

internal_source (Optional[MusicOnHoldUserSourceRead20]):

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

@dataclass(kw_only=True)
class UserMusicOnHoldUserGetResponse20(OCIDataResponse):
    """Response to UserMusicOnHoldUserGetRequest20.

    Attributes:

        enable_video (bool):

        source (MusicOnHoldUserSourceRead20):

        use_alternate_source_for_internal_calls (bool):

        internal_source (Optional[MusicOnHoldUserSourceRead20]):

    """

    enable_video: bool = field(metadata={"alias": "enableVideo"})

    source: MusicOnHoldUserSourceRead20 = field(metadata={"alias": "source"})

    use_alternate_source_for_internal_calls: bool = field(
        metadata={"alias": "useAlternateSourceForInternalCalls"}
    )

    internal_source: Optional[MusicOnHoldUserSourceRead20] = field(
        default=None, metadata={"alias": "internalSource"}
    )

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 UserMusicOnHoldUserGetRequest20

client = Client()

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

print(response)