Skip to content

UserBroadWorksAnywhereGetPhoneNumberRequest

Bases: OCIRequest

Get a broadworks anywhere phone number The response is UserBroadWorksAnywhereGetPhoneNumberResponse.

Attributes:

user_id (str):

phone_number (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksAnywhereGetPhoneNumberRequest(OCIRequest):
    """Get a broadworks anywhere phone number
        The response is UserBroadWorksAnywhereGetPhoneNumberResponse.

    Attributes:

        user_id (str):

        phone_number (str):

    """

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

    phone_number: str = field(metadata={"alias": "phoneNumber"})

Responses

Bases: OCIDataResponse

Response to the UserBroadWorksAnywhereGetPhoneNumberRequest. The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", "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 caombination 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 exension is available a blank space is provided instead.

Attributes:

description (Optional[str]):

outbound_alternate_number (Optional[str]):

is_active (bool):

broadworks_call_control (bool):

use_diversion_inhibitor (bool):

answer_confirmation_required (bool):

criteria_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksAnywhereGetPhoneNumberResponse(OCIDataResponse):
    """Response to the UserBroadWorksAnywhereGetPhoneNumberRequest.
        The criteria table's column headings are: \"Is Active\", \"Criteria Name\", \"Time Schedule\",
        \"Calls From\", \"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 caombination 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 exension is available a blank space is provided instead.

    Attributes:

        description (Optional[str]):

        outbound_alternate_number (Optional[str]):

        is_active (bool):

        broadworks_call_control (bool):

        use_diversion_inhibitor (bool):

        answer_confirmation_required (bool):

        criteria_table (OCITable):

    """

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

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

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

    broadworks_call_control: bool = field(metadata={"alias": "broadworksCallControl"})

    use_diversion_inhibitor: bool = field(metadata={"alias": "useDiversionInhibitor"})

    answer_confirmation_required: bool = field(
        metadata={"alias": "answerConfirmationRequired"}
    )

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

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserBroadWorksAnywhereGetPhoneNumberRequest

client = Client()

command = UserBroadWorksAnywhereGetPhoneNumberRequest(
    user_id=...,
    phone_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserBroadWorksAnywhereGetPhoneNumberRequest",
    user_id=...,
    phone_number=...,
)

print(response)