GroupCallPickupGetInstanceRequest

Bases: OCIRequest

Gets a Call Pickup group. The response is either GroupCallPickupGetInstanceResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

name (str):

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

@dataclass(kw_only=True)
class GroupCallPickupGetInstanceRequest(OCIRequest):
    """Gets a Call Pickup group.
        The response is either GroupCallPickupGetInstanceResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        name (str):

    """

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

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

    name: str = field(metadata={"alias": "name"})

Responses

Bases: OCIDataResponse

Response to the GroupCallPickupGetInstanceRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".

Attributes:

user_table (OCITable):

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

@dataclass(kw_only=True)
class GroupCallPickupGetInstanceResponse(OCIDataResponse):
    """Response to the GroupCallPickupGetInstanceRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".

    Attributes:

        user_table (OCITable):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

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 GroupCallPickupGetInstanceRequest

client = Client()

command = GroupCallPickupGetInstanceRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCallPickupGetInstanceRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
)

print(response)