Skip to content

GroupMusicOnHoldAddInstanceRequest23

Bases: OCIRequest

Add a Music on Hold Instance to a department. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: - useDynamicMOHDuringCallHold

Attributes:

service_provider_id (str):

group_id (str):

department (DepartmentKey):

is_active_during_call_hold (bool):

is_active_during_call_park (bool):

is_active_during_busy_camp_on (bool):

source (MusicOnHoldSourceAdd22):

use_alternate_source_for_internal_calls (bool):

internal_source (Optional[MusicOnHoldSourceAdd22]):

use_dynamic_moh_during_call_hold (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupMusicOnHoldAddInstanceRequest23(OCIRequest):
    """Add a Music on Hold Instance to a department.
        The response is either SuccessResponse or ErrorResponse.
        The following elements are only used in AS data mode and ignored in XS data mode:
        - useDynamicMOHDuringCallHold

    Attributes:

        service_provider_id (str):

        group_id (str):

        department (DepartmentKey):

        is_active_during_call_hold (bool):

        is_active_during_call_park (bool):

        is_active_during_busy_camp_on (bool):

        source (MusicOnHoldSourceAdd22):

        use_alternate_source_for_internal_calls (bool):

        internal_source (Optional[MusicOnHoldSourceAdd22]):

        use_dynamic_moh_during_call_hold (bool):

    """

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

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

    department: DepartmentKey = field(metadata={"alias": "department"})

    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"}
    )

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

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

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

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

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 GroupMusicOnHoldAddInstanceRequest23

client = Client()

command = GroupMusicOnHoldAddInstanceRequest23(
    service_provider_id=...,
    group_id=...,
    department=...,
    is_active_during_call_hold=...,
    is_active_during_call_park=...,
    is_active_during_busy_camp_on=...,
    source=...,
    use_alternate_source_for_internal_calls=...,
    internal_source=...,
    use_dynamic_moh_during_call_hold=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupMusicOnHoldAddInstanceRequest23",
    service_provider_id=...,
    group_id=...,
    department=...,
    is_active_during_call_hold=...,
    is_active_during_call_park=...,
    is_active_during_busy_camp_on=...,
    source=...,
    use_alternate_source_for_internal_calls=...,
    internal_source=...,
    use_dynamic_moh_during_call_hold=...,
)

print(response)