Skip to content

GroupMusicOnHoldModifyInstanceRequest22

Bases: OCIRequest

Modify data for a group or department Music On Hold Instance. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

department (Optional[DepartmentKey]):

is_active_during_call_hold (Optional[bool]):

is_active_during_call_park (Optional[bool]):

is_active_during_busy_camp_on (Optional[bool]):

source (Optional[MusicOnHoldSourceModify22]):

use_alternate_source_for_internal_calls (Optional[bool]):

internal_source (Optional[MusicOnHoldSourceModify22]):

use_dynamic_moh_during_call_hold (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupMusicOnHoldModifyInstanceRequest22(OCIRequest):
    """Modify data for a group or department Music On Hold Instance.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        department (Optional[DepartmentKey]):

        is_active_during_call_hold (Optional[bool]):

        is_active_during_call_park (Optional[bool]):

        is_active_during_busy_camp_on (Optional[bool]):

        source (Optional[MusicOnHoldSourceModify22]):

        use_alternate_source_for_internal_calls (Optional[bool]):

        internal_source (Optional[MusicOnHoldSourceModify22]):

        use_dynamic_moh_during_call_hold (Optional[bool]):

    """

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

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

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

    is_active_during_call_hold: Optional[bool] = field(
        default=None, metadata={"alias": "isActiveDuringCallHold"}
    )

    is_active_during_call_park: Optional[bool] = field(
        default=None, metadata={"alias": "isActiveDuringCallPark"}
    )

    is_active_during_busy_camp_on: Optional[bool] = field(
        default=None, metadata={"alias": "isActiveDuringBusyCampOn"}
    )

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

    use_alternate_source_for_internal_calls: Optional[bool] = field(
        default=None, metadata={"alias": "useAlternateSourceForInternalCalls"}
    )

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

    use_dynamic_moh_during_call_hold: Optional[bool] = field(
        default=None, metadata={"alias": "useDynamicMOHDuringCallHold"}
    )

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 GroupMusicOnHoldModifyInstanceRequest22

client = Client()

command = GroupMusicOnHoldModifyInstanceRequest22(
    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.client import Client

client = Client()

response = client.raw_command("GroupMusicOnHoldModifyInstanceRequest22",
    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)