Skip to content

GroupMusicOnHoldGetInstanceRequest23V2

Bases: OCIRequest

Get a Music On Hold data for a group or department instance. The response is either GroupMusicOnHoldGetInstanceResponse23V2 or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

department (Optional[DepartmentKey]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupMusicOnHoldGetInstanceRequest23V2(OCIRequest):
    """Get a Music On Hold data for a group or department instance.
        The response is either GroupMusicOnHoldGetInstanceResponse23V2 or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        department (Optional[DepartmentKey]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    department: Optional[DepartmentKey] = field(
        default=None, metadata={"alias": "department"}
    )

Responses

Bases: OCIDataResponse

Response to the GroupMusicOnHoldGetInstanceRequest23V2. The following elements are only used in AS data mode: - useDynamicMOHDuringCallHold, value "false" is returned in XS data mode.

Attributes:

service_user_id (str):

is_active_during_call_hold (bool):

is_active_during_call_park (bool):

is_active_during_busy_camp_on (bool):

enable_video (bool):

source (MusicOnHoldSourceRead22V3):

use_alternate_source_for_internal_calls (bool):

internal_source (MusicOnHoldSourceRead22V3):

use_dynamic_moh_during_call_hold (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupMusicOnHoldGetInstanceResponse23V2(OCIDataResponse):
    """Response to the GroupMusicOnHoldGetInstanceRequest23V2.
        The following elements are only used in AS data mode:
        - useDynamicMOHDuringCallHold, value \"false\" is returned in XS data mode.

    Attributes:

        service_user_id (str):

        is_active_during_call_hold (bool):

        is_active_during_call_park (bool):

        is_active_during_busy_camp_on (bool):

        enable_video (bool):

        source (MusicOnHoldSourceRead22V3):

        use_alternate_source_for_internal_calls (bool):

        internal_source (MusicOnHoldSourceRead22V3):

        use_dynamic_moh_during_call_hold (bool):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    is_active_during_call_hold: bool = field(
        metadata={"alias": "isActiveDuringCallHold"}
    )

    is_active_during_call_park: bool = field(
        metadata={"alias": "isActiveDuringCallPark"}
    )

    is_active_during_busy_camp_on: bool = field(
        metadata={"alias": "isActiveDuringBusyCampOn"}
    )

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

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

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

    internal_source: MusicOnHoldSourceRead22V3 = field(
        metadata={"alias": "internalSource"}
    )

    use_dynamic_moh_during_call_hold: bool = field(
        metadata={"alias": "useDynamicMOHDuringCallHold"}
    )

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 GroupMusicOnHoldGetInstanceRequest23V2

client = Client()

command = GroupMusicOnHoldGetInstanceRequest23V2(
    service_provider_id=...,
    group_id=...,
    department=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupMusicOnHoldGetInstanceRequest23V2",
    service_provider_id=...,
    group_id=...,
    department=...,
)

print(response)