UserCallForwardingSelectiveGetRequest16

Bases: OCIRequest

Get the user's call forwarding selective service setting. The response is either a UserCallForwardingSelectiveGetResponse16 or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserCallForwardingSelectiveGetRequest16(OCIRequest):
    """Get the user's call forwarding selective service setting.
        The response is either a UserCallForwardingSelectiveGetResponse16 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserCallForwardingSelectiveGetRequest16. The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Forward To", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". The following columns are only returned in AS data mode: "Calls To Type", "Calls To Number" and "Calls To Extension"

The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:
  - Primary
  - Alternate X (where x is a number between 1 and 10)
  - Mobility
The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:
  - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number.
  - When no number is available a blank space is provided instead.
The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:
  - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension.
  - For Mobility Calls To Type, this is always blank.
  - When no extension is available a blank space is provided instead.

Attributes:

is_active (bool):

default_forward_to_phone_number (Optional[str]):

play_ring_reminder (bool):

criteria_table (OCITable):

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

@dataclass(kw_only=True)
class UserCallForwardingSelectiveGetResponse16(OCIDataResponse):
    """Response to the UserCallForwardingSelectiveGetRequest16. The criteria table's column headings are:
        \"Is Active\", \"Criteria Name\", \"Time Schedule\", \"Calls From\", \"Forward To\", \"Blacklisted\", \"Holiday Schedule\", \"Calls To Type\", \"Calls To Number\" and \"Calls To Extension\".
        The following columns are only returned in AS data mode:
          \"Calls To Type\", \"Calls To Number\" and \"Calls To Extension\"

        The possible values for the \"Calls To Type\" column are the following or a combination of them separated by comma:
          - Primary
          - Alternate X (where x is a number between 1 and 10)
          - Mobility
        The possible values for the \"Calls To Number\" column are the following or a combination of them separated by comma:
          - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number.
          - When no number is available a blank space is provided instead.
        The possible values for the \"Calls To Extension\" column are the following or a combination of them separated by comma:
          - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension.
          - For Mobility Calls To Type, this is always blank.
          - When no extension is available a blank space is provided instead.

    Attributes:

        is_active (bool):

        default_forward_to_phone_number (Optional[str]):

        play_ring_reminder (bool):

        criteria_table (OCITable):

    """

    is_active: bool = field(metadata={"alias": "isActive"})

    default_forward_to_phone_number: Optional[str] = field(
        default=None, metadata={"alias": "defaultForwardToPhoneNumber"}
    )

    play_ring_reminder: bool = field(metadata={"alias": "playRingReminder"})

    criteria_table: OCITable = field(metadata={"alias": "criteriaTable"})

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 UserCallForwardingSelectiveGetRequest16

client = Client()

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

print(response)