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/commands/commands.py
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/commands/commands.py
151197 151198 151199 151200 151201 151202 151203 151204 151205 151206 151207 151208 151209 151210 151211 151212 151213 151214 151215 151216 151217 151218 151219 151220 151221 151222 151223 151224 151225 151226 151227 151228 151229 151230 151231 151232 151233 151234 151235 151236 151237 151238 151239 151240 151241 151242 151243 151244 151245 151246 151247 151248 151249 151250 151251 | |
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.commands import UserBroadWorksAnywhereGetPhoneNumberRequest
client = Client()
command = UserBroadWorksAnywhereGetPhoneNumberRequest(
user_id=...,
phone_number=...,
)
response = client.command(command)
print(response)