from collections.abc import Generator
from dataclasses import dataclass
from typing import Optional, List
from pydantic import Field, TypeAdapter
from .emergency_services import LocationEmergencyServicesApi
from .intercept import LocationInterceptApi
from .internal_dialing import InternalDialingApi
from .moh import LocationMoHApi
from .numbers import LocationNumbersApi
from .receptionist_contacts import ReceptionistContactsDirectoryApi
from .vm import LocationVoicemailSettingsApi
from ...api_child import ApiChild
from ...base import ApiModel, to_camel, enum_str
from ...base import SafeEnum as Enum
from ...common import ValidateExtensionsResponse, RouteType, DeviceCustomization, UserType, IdAndName
from ...locations import Location
from ...person_settings.available_numbers import AvailableNumber
from ...person_settings.common import ApiSelector
from ...person_settings.ecbn import ECBNEffectiveLevel, ECBNQuality
from ...person_settings.permissions_out import OutgoingPermissionsApi
from ...rest import RestSession
__all__ = ['CallingLineId', 'PSTNConnection', 'TelephonyLocation', 'CallBackSelected', 'ContactDetails',
'LocationECBNLocation', 'LocationECBNLocationMember', 'LocationECBN',
'BlockingDisableCalling', 'NonBlockingDisableCalling', 'BlockingUnlessForced',
'LocationDeleteStatus', 'SafeDeleteCheckResponse', 'LocationCallCaptions', 'TelephonyLocationApi']
[docs]
class CallingLineId(ApiModel):
"""
Location calling line information.
"""
#: Group calling line ID name. By default it will be org name.
#: when updating the name make sure to also include the phone number
name: Optional[str] = None
#: Directory Number / Main number in E164 Forma
phone_number: Optional[str] = None
[docs]
class PSTNConnection(ApiModel):
"""
Connection details
"""
#: Webex Calling location only supports TRUNK and ROUTE_GROUP connection type.
type: RouteType
#: A unique identifier of route type.
id: Optional[str] = None
[docs]
class TelephonyLocation(ApiModel):
#: A unique identifier for the location.
location_id: Optional[str] = Field(alias='id', default=None)
#: The name of the location.
name: Optional[str] = None
#: Location's phone announcement language.
announcement_language: Optional[str] = None
#: Location calling line information.
calling_line_id: Optional[CallingLineId] = None
#: Connection details are only returned for local PSTN types of TRUNK or ROUTE_GROUP.
connection: Optional[PSTNConnection] = None
#: PSTN connection ID given for locations with a PSTN subscription.
subscription_id: Optional[str] = None
#: External Caller ID Name value. Unicode characters.
external_caller_id_name: Optional[str] = None
#: Limit on the number of people at the location, Read-Only.
user_limit: Optional[int] = None
#: Emergency Location Identifier for a location. Set this field to provide the SIP access network information to
#: the provider which will be used to populate the SIP P-Access-Network-Info header. This is helpful to establish
#: the location of a device when you make an emergency call.
p_access_network_info: Optional[str] = None
#: Must dial to reach an outside line, default is None.
outside_dial_digit: Optional[str] = None
#: True when enforcing outside dial digit at location level to make PSTN calls.
enforce_outside_dial_digit: Optional[bool] = None
#: Must dial a prefix when calling between locations having same extension within same location.
routing_prefix: Optional[str] = None
#: IP Address, hostname, or domain. Read-Only.
default_domain: Optional[str] = None
#: Chargeable number for the line placing the call. When this is set, all calls placed from this location will
#: include a P-Charge-Info header with the selected number in the SIP INVITE.
charge_number: Optional[str] = None
#: Indicates whether the location's chargeNumber (if set) is enabled for use as the P-Charge-Info header in the
#: SIP INVITE for all PSTN calls placed from this location. The field is returned as true if the location's PSTN
#: allows use of the chargeNumber.
use_charge_number_for_pcharge_info: Optional[bool] = Field(default=None, alias='useChargeNumberForPChargeInfo')
#: True if E911 setup is required.
e911_setup_required: Optional[bool] = None
def update(self) -> dict:
"""
restricted data used for updates
:meta private:
"""
data = self.model_dump(mode='json', exclude_unset=True, by_alias=True,
exclude={'location_id', 'name', 'subscription_id', 'user_limit', 'default_domain',
'e911_setup_required'})
if not self.connection:
data.pop('connection', None)
return data
[docs]
class CallBackSelected(str, Enum):
#: Location TN.
location_number = 'LOCATION_NUMBER'
#: Assigned number of a user, workspace, virtual line or hunt group in the location.
location_member_number = 'LOCATION_MEMBER_NUMBER'
[docs]
class LocationECBNLocation(ApiModel):
#: The location DN.
phone_number: Optional[str] = None
#: The name of the location.
name: Optional[str] = None
#: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying
#: fallback rules as necessary.
effective_level: Optional[ECBNEffectiveLevel] = None
#: Location calling line ID (CLID) number. Avaliable only when number is present and quality would be invalid.
effective_value: Optional[str] = None
#: Used to represent whether a number is a recommended ECBN.
quality: Optional[ECBNQuality] = None
[docs]
class LocationECBNLocationMember(ApiModel):
#: The member DN.
phone_number: Optional[str] = None
#: The member first name.
first_name: Optional[str] = None
#: The member last name. Always contains `.` if the member is a place.
last_name: Optional[str] = None
#: Member ID of user/place/virtual line/hunt group within the location.
member_id: Optional[str] = None
#: Member Type.
member_type: Optional[UserType] = None
#: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying
#: fallback rules as necessary.
effective_level: Optional[ECBNEffectiveLevel] = None
#: Location CLID number. Avaliable only when number is present and quality would be invalid.
effective_value: Optional[str] = None
#: Used to represent whether a number is a recommended ECBN.
quality: Optional[ECBNQuality] = None
[docs]
class LocationECBN(ApiModel):
#: Data relevant to this location.
location_info: Optional[LocationECBNLocation] = None
#: Data relevant to the user/place/virtual line/hunt group (member) selected for ECBN.
location_member_info: Optional[LocationECBNLocationMember] = None
#: Selected number type to configure emergency call back.
selected: Optional[CallBackSelected] = None
[docs]
class BlockingDisableCalling(ApiModel):
#: Indicates if this is the last calling location in the organization.
last_location: Optional[bool] = None
#: Number of trunks in use at this location.
trunks_in_use_count: Optional[int] = None
#: Number of users in use at this location.
users_in_use_count: Optional[int] = None
#: Number of workspaces in use at this location.
workspaces_in_use_count: Optional[int] = None
#: Number of virtual lines in use at this location.
virtual_line_in_use_count: Optional[int] = None
#: Indicates if there are pending number orders for this location.
numbers_order_pending: Optional[bool] = None
[docs]
class NonBlockingDisableCalling(ApiModel):
#: Indicates if there are phone numbers at this location.
numbers_present: Optional[bool] = None
[docs]
class BlockingUnlessForced(ApiModel):
#: Indicates if there are non-user entities in use at this location that would block disabling unless force is
#: applied.
non_user_entities_in_use: Optional[bool] = None
#: Total number of trunks at this location.
trunks_count: Optional[int] = None
[docs]
class LocationDeleteStatus(str, Enum):
#: Disable Webex Calling location operation is blocked and cannot proceed.
blocked = 'BLOCKED'
#: Disable Webex Calling location operation can proceed without any restrictions.
unblocked = 'UNBLOCKED'
#: Disable Webex Calling location operation requires forceDelete to be set to true.
force_required = 'FORCE_REQUIRED'
[docs]
class SafeDeleteCheckResponse(ApiModel):
#: Status of disable calling location safe delete check.
location_delete_status: Optional[LocationDeleteStatus] = None
blocking: Optional[BlockingDisableCalling] = None
non_blocking: Optional[NonBlockingDisableCalling] = None
blocking_unless_forced: Optional[BlockingUnlessForced] = None
[docs]
class LocationCallCaptions(ApiModel):
#: Location-level closed captions are enabled or disabled.
location_closed_captions_enabled: Optional[bool] = None
#: Location-level transcripts are enabled or disabled.
location_transcripts_enabled: Optional[bool] = None
#: Organization closed captions are enabled or disabled.
org_closed_captions_enabled: Optional[bool] = None
#: Organization transcripts are enabled or disabled.
org_transcripts_enabled: Optional[bool] = None
#: If `useOrgSettingsEnabled` is `true`, organization-level settings will control the location's closed captions
#: and transcripts. Otherwise, location-level settings are used.
use_org_settings_enabled: Optional[bool] = None
def update(self) -> dict:
"""
dict for updates
:meta private:
"""
return self.model_dump(mode='json', exclude_unset=True, by_alias=True, exclude_none=True,
exclude={'org_closed_captions_enabled', 'org_transcripts_enabled'})
[docs]
@dataclass(init=False, repr=False)
class TelephonyLocationApi(ApiChild, base='telephony/config/locations'):
#: emergency services
emergency_services: LocationEmergencyServicesApi
#: call intercept settings
intercept: LocationInterceptApi
#: internal dialing settings
internal_dialing: InternalDialingApi
#: moh settings
moh: LocationMoHApi
#: number settings
number: LocationNumbersApi
#: outgoing permissions settings
permissions_out: OutgoingPermissionsApi
#: Location VM settings (only enable/disable transcription for now)
voicemail: LocationVoicemailSettingsApi
#: Receptionist contacts directories
receptionist_contacts_directory: ReceptionistContactsDirectoryApi
[docs]
def __init__(self, session: RestSession):
super().__init__(session=session)
self.emergency_services = LocationEmergencyServicesApi(session=session)
self.intercept = LocationInterceptApi(session=session)
self.internal_dialing = InternalDialingApi(session=session)
self.moh = LocationMoHApi(session=session)
self.number = LocationNumbersApi(session=session)
self.permissions_out = OutgoingPermissionsApi(session=session, selector=ApiSelector.location)
self.voicemail = LocationVoicemailSettingsApi(session=session)
self.receptionist_contacts_directory = ReceptionistContactsDirectoryApi(session=session)
[docs]
def generate_password(self, location_id: str, generate: list[str] = None, org_id: str = None):
"""
Generate example password for Location
Generates an example password using the effective password settings for the location. If you don't specify
anything in the generate field or don't provide a request body, then you will receive a SIP password by default.
It's used while creating a trunk and shouldn't be used anywhere else.
Generating an example password requires a full or write-only administrator auth token with a scope
of spark-admin:telephony_config_write.
:param location_id: Location for which example password has to be generated.
:type location_id: str
:param generate: password settings array.
:type generate: list[str]
:param org_id: Organization to which location belongs.
:type org_id: str
:return: new password
:rtype: str
"""
params = org_id and {'orgId': org_id} or None
body = generate and {'generate': generate} or {}
url = self.ep(f'{location_id}/actions/generatePassword/invoke')
data = self.post(url=url, params=params, json=body)
return data['exampleSipPassword']
[docs]
def validate_extensions(self, location_id: str, extensions: list[str],
org_id: str = None) -> ValidateExtensionsResponse:
"""
Validate Extensions
Validate extensions for a specific location.
Validating extensions requires a full administrator auth token with a scope
of spark-admin:telephony_config_write.
:param location_id: Validate extensions for this location.
:type location_id: str
:param extensions: Array of extensions that will be validated.
:type extensions: list[str]
:param org_id: Validate extensions for this organization.
:type org_id: str
:return: Validation result
:rtype: :class:`wxc_sdk.common.ValidateExtensionsResponse`
"""
url = self.ep(f'{location_id}/actions/validateExtensions/invoke')
body = {'extensions': extensions}
params = org_id and {'orgId': org_id} or None
data = self.post(url=url, params=params, json=body)
return ValidateExtensionsResponse.model_validate(data)
[docs]
def details(self, location_id: str, org_id: str = None) -> TelephonyLocation:
"""
Get Location Webex Calling Details
Shows Webex Calling details for a location, by ID.
Specify the location ID in the locationId parameter in the URI.
Searching and viewing location in your organization requires an administrator auth token with
the spark-admin:telephony_config_read scope.
:param location_id: Retrieve Webex Calling location attributes for this location.
:type location_id: str
:param org_id: Retrieve Webex Calling location attributes for this organization.
:type org_id: str
:return: Webex Calling details for location
:rtype: :class:`TelephonyLocation`
"""
params = org_id and {'orgId': org_id}
url = self.ep(location_id)
data = self.get(url=url, params=params)
return TelephonyLocation.model_validate(data)
[docs]
def enable_for_calling(self, location: Location, org_id: str = None) -> str:
"""
Enable a Location for Webex Calling
Enable a location by adding it to Webex Calling. This add Webex Calling support to a
location created using the POST /v1/locations API.
Locations are used to support calling features which can be defined at the location level.
This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
:return: A unique identifier for the location.
:rtype: str
"""
params = org_id and {'orgId': org_id}
url = self.ep()
body = location.model_dump_json()
data = self.post(url=url, data=body, params=params)
return data['id']
[docs]
def list(self, name: str = None, order: str = None, org_id: str = None) -> Generator[TelephonyLocation, None, None]:
"""
List Locations Webex Calling Details
Lists Webex Calling locations for an organization with Webex Calling details.
Searching and viewing locations with Webex Calling details in your
organization require an administrator auth token with the
`spark-admin:telephony_config_read` scope.
:param name: List locations whose name contains this string.
:type name: str
:param order: Sort the list of locations based on name, either asc or desc.
:type order: str
:param org_id: List locations for this organization.
:type org_id: str
:return: generator of :class:`TelephonyLocation` instances
"""
params = {to_camel(k): v
for k, v in locals().items()
if k != 'self' and v is not None}
url = self.ep()
return self.session.follow_pagination(url=url, model=TelephonyLocation, params=params, item_key='locations')
[docs]
def update(self, location_id: str, settings: TelephonyLocation, org_id: str = None) -> Optional[str]:
"""
Update Location Webex Calling Details
Update Webex Calling details for a location, by ID.
Specifies the location ID in the `locationId` parameter in the URI.
Modifying the `connection` via API is only supported for the local PSTN types of `TRUNK` and `ROUTE_GROUP`.
Updating a location in your organization requires an administrator auth token with the
`spark-admin:telephony_config_write` scope.
Example :
.. code-block:: python
api.telephony.location.update(location_id=location_id,
settings=TelephonyLocation(
calling_line_id=CallingLineId(
phone_number=tn),
routing_prefix=routing_prefix,
outside_dial_digit='9'))
:param location_id: Updating Webex Calling location attributes for this location.
:type location_id: str
:param settings: settings to update
:type settings: :class:`TelephonyLocation`
:param org_id: Updating Webex Calling location attributes for this organization.
:type org_id: str
:return: batch job id of update job if one is created
:rtype: str
"""
data = settings.update()
params = org_id and {'orgId': org_id} or None
url = self.ep(location_id)
data = self.put(url=url, json=data, params=params)
if data:
return data.get('batchJobId')
return
[docs]
def change_announcement_language(self, location_id: str, language_code: str, agent_enabled: bool = None,
service_enabled: bool = None, org_id: str = None):
"""
Change Announcement Language
Change announcement language for the given location.
Change announcement language for current people/workspaces and/or existing feature configurations. This does
not change the default announcement language which is applied to new users/workspaces and new feature
configurations.
Changing announcement language for the given location requires a full administrator auth token with a scope
of spark-admin:telephony_config_write.
:param location_id: Change announcement language for this location.
:type location_id: str
:param language_code: Language code.
:type language_code: str
:param agent_enabled: Set to true to change announcement language for existing people and workspaces.
:type agent_enabled: bool
:param service_enabled: Set to true to change announcement language for existing feature configurations.
:type service_enabled: bool
:param org_id: Change announcement language for this organization.
:type org_id: str
"""
params = org_id and {'orgId': org_id} or None
body = {'announcementLanguageCode': language_code}
if agent_enabled is not None:
body['agentEnabled'] = agent_enabled
if service_enabled is not None:
body['serviceEnabled'] = service_enabled
url = self.session.ep(f'{location_id}/actions/modifyAnnouncementLanguage/invoke')
self.put(url, json=body, params=params)
[docs]
def read_ecbn(self, location_id: str,
org_id: str = None) -> LocationECBN:
"""
Get a Location Emergency callback number
Get location emergency callback number.
* To retrieve location callback number requires a full, user or read-only administrator or location
administrator auth token with a scope of `spark-admin:telephony_config_read`.
:param location_id: Update location attributes for this location.
:type location_id: str
:param org_id: Update location attributes for this organization.
:type org_id: str
:rtype: :class:`LocationECBN`
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep(f'{location_id}/features/emergencyCallbackNumber')
data = super().get(url, params=params)
r = LocationECBN.model_validate(data)
return r
[docs]
def update_ecbn(self, location_id: str, selected: CallBackSelected,
location_member_id: str = None, org_id: str = None):
"""
Update a Location Emergency callback number
Update details for a location emergency callback number.
* Updating a location callback number requires a full administrator or location administrator auth token with a
scope of `spark-admin:telephony_config_write`.
:param location_id: Update location attributes for this location.
:type location_id: str
:param selected: Selected number type to configure emergency call back.
:type selected: CallBackSelected
:param location_member_id: Member ID of user/place within the location. Required if `LOCATION_MEMBER_NUMBER` is
selected.
:type location_member_id: str
:param org_id: Update location attributes for this organization.
:type org_id: str
:rtype: None
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
body = dict()
body['selected'] = enum_str(selected)
if location_member_id is not None:
body['locationMemberId'] = location_member_id
url = self.ep(f'{location_id}/features/emergencyCallbackNumber')
super().put(url, params=params, json=body)
[docs]
def device_settings(self, location_id: str, org_id: str = None) -> DeviceCustomization:
"""
Get device override settings for a location.
This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
:param location_id: Unique identifier for the location
:type location_id: str
:param org_id: Settings on the device in this organization
:type org_id: str
:return: device customization response
:rtype: DeviceCustomization
"""
params = org_id and {'orgId': org_id} or None
url = self.ep(f'{location_id}/devices/settings')
data = self.get(url=url, params=params)
return DeviceCustomization.model_validate(data)
[docs]
def phone_numbers_available_for_external_caller_id(self, location_id: str,
phone_number: List[str] = None,
owner_name: str = None, person_id: str = None,
org_id: str = None,
**params) -> Generator[AvailableNumber, None, None]:
"""
Get the List of Phone Numbers Available for External Caller ID
Get the list of phone numbers available for external caller ID usage by a Webex Calling entity (such as a
person, virtual line, or workspace) within the specified location.
Numbers from the specified location are returned and cross location numbers are returned as well where the
number's location has the same country, PSTN provider, and zone (only applicable for India locations) as the
specified location.
When `personId` is specified, and the person belongs to a cisco PSTN location, has a mobile number assigned as
primary DN, and does not have a billing plan, only the assigned mobile number is returned as the available
number for caller ID.
The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment
or association of these numbers to members or features.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a
scope of `spark-admin:telephony_config_read`.
:param location_id: Retrieve available external caller ID numbers for this location.
:type location_id: str
:param phone_number: Filter phone numbers based on the provided list in the `phoneNumber` array.
:type phone_number: list[str]
:param owner_name: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is
255.
:type owner_name: str
:param person_id: Retrieve available external caller ID numbers for this person. If `personId` is not provided
it may result in the unsuccessful assignment of the returned number. This parameter has no effect when
workspace or virtual line ID is used.
:type person_id: str
:param org_id: List numbers for this organization.
:type org_id: str
:return: Generator yielding :class:`AvailableNumber` instances
"""
if org_id is not None:
params['orgId'] = org_id
if phone_number is not None:
params['phoneNumber'] = ','.join(phone_number)
if owner_name is not None:
params['ownerName'] = owner_name
if person_id is not None:
params['personId'] = person_id
url = self.ep(f'{location_id}/externalCallerId/availableNumbers')
return self.session.follow_pagination(url=url, model=AvailableNumber, item_key='phoneNumbers', params=params)
[docs]
def phone_numbers(self, location_id: str,
phone_number: List[str] = None,
owner_name: str = None, org_id: str = None,
**params) -> Generator[AvailableNumber, None, None]:
"""
Get Available Phone Numbers for a Location with Given Criteria
List the service and standard PSTN numbers that are available to be assigned as the location's main number.
These numbers are associated with the location specified in the request URL and can be active/inactive and
assigned to an owning entity or unassigned.
The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment
or association of these numbers to members or features.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a
scope of `spark-admin:telephony_config_read`.
:param location_id: Return the list of phone numbers for this location within the given organization. The
maximum length is 36.
:type location_id: str
:param phone_number: Filter phone numbers based on the comma-separated list provided in the `phoneNumber`
array.
:type phone_number: list[str]
:param owner_name: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is
255.
:type owner_name: str
:param org_id: List numbers for this organization.
:type org_id: str
:return: Generator yielding :class:`AvailableNumber` instances
"""
if org_id is not None:
params['orgId'] = org_id
if phone_number is not None:
params['phoneNumber'] = ','.join(phone_number)
if owner_name is not None:
params['ownerName'] = owner_name
url = self.ep(f'{location_id}/availableNumbers')
return self.session.follow_pagination(url=url, model=AvailableNumber, item_key='phoneNumbers', params=params)
[docs]
def webex_go_available_phone_numbers(self, location_id: str, phone_number: List[str] = None,
org_id: str = None,
**params) -> Generator[AvailableNumber, None, None]:
"""
Get Webex Go Available Phone Numbers
List standard numbers that are available to be assigned as the webex go phone number.
These numbers are associated with the location specified in the request URL, can be active or inactive, and are
unassigned.
The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment
or association of these numbers to members or features.
Retrieving this list requires a full, read-only or location administrator auth token with a scope of
`spark-admin:telephony_config_read`.
:param location_id: Return the list of phone numbers for this location within the given organization. The
maximum length is 36.
:type location_id: str
:param phone_number: Filter phone numbers based on the comma-separated list provided in the `phoneNumber`
array.
:type phone_number: list[str]
:param org_id: List numbers for this organization.
:type org_id: str
:return: Generator yielding :class:`AvailableNumber` instances
"""
if org_id is not None:
params['orgId'] = org_id
if phone_number is not None:
params['phoneNumber'] = ','.join(phone_number)
url = self.ep(f'{location_id}/webexGo/availableNumbers')
return self.session.follow_pagination(url=url, model=AvailableNumber, item_key='phoneNumbers', params=params)
[docs]
def ecbn_available_phone_numbers(self, location_id: str, phone_number: List[str] = None,
owner_name: str = None, org_id: str = None,
**params) -> Generator[AvailableNumber, None, None]:
"""
Get Location ECBN Available Phone Numbers
List standard numbers that are available to be assigned as the location's emergency callback number.
These numbers are associated with the location specified in the request URL, can be active or inactive, and are
assigned to an owning entity.
The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment
or association of these numbers to members or features.
Retrieving this list requires a full, read-only or location administrator auth token with a scope of
`spark-admin:telephony_config_read`.
:param location_id: Return the list of phone numbers for this location within the given organization. The
maximum length is 36.
:type location_id: str
:param phone_number: Filter phone numbers based on the comma-separated list provided in the `phoneNumber`
array.
:type phone_number: list[str]
:param owner_name: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is
255.
:type owner_name: str
:param org_id: List numbers for this organization.
:type org_id: str
:return: Generator yielding :class:`AvailableNumber` instances
"""
if org_id is not None:
params['orgId'] = org_id
if phone_number is not None:
params['phoneNumber'] = ','.join(phone_number)
if owner_name is not None:
params['ownerName'] = owner_name
url = self.ep(f'{location_id}/emergencyCallbackNumber/availableNumbers')
return self.session.follow_pagination(url=url, model=AvailableNumber, item_key='phoneNumbers', params=params)
[docs]
def charge_number_available_phone_numbers(self, location_id: str, phone_number: List[str] = None,
owner_name: str = None, org_id: str = None,
**params) -> Generator[AvailableNumber, None, None]:
"""
Get Available Charge Numbers for a Location with Given Criteria
List the numbers that are available to be assigned as the location's charge number.
These numbers are non-toll-free and non-mobile numbers assigned to the location specified in the request URL.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a
scope of `spark-admin:telephony_config_read`.
:param location_id: Return the list of available charge numbers for this location within the given
organization. The maximum length is 36.
:type location_id: str
:param phone_number: Filter phone numbers based on the comma-separated list provided in the `phoneNumber`
array.
:type phone_number: list[str]
:param owner_name: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is
255.
:type owner_name: str
:param org_id: List numbers for this organization.
:type org_id: str
:return: Generator yielding :class:`AvailableNumber` instances
"""
if org_id is not None:
params['orgId'] = org_id
if phone_number is not None:
params['phoneNumber'] = ','.join(phone_number)
if owner_name is not None:
params['ownerName'] = owner_name
url = self.ep(f'{location_id}/chargeNumber/availableNumbers')
return self.session.follow_pagination(url=url, model=AvailableNumber,
item_key='phoneNumbers', params=params)
[docs]
def call_intercept_available_phone_numbers(self, location_id: str, phone_number: List[str] = None,
owner_name: str = None, org_id: str = None,
**params) -> Generator[AvailableNumber, None, None]:
"""
Get Location Call Intercept Available Phone Numbers
List service and standard numbers that are available to be assigned as the location's call intercept number.
These numbers are associated with the location specified in the request URL and can be active/inactive and
assigned to an owning entity or unassigned.
The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment
or association of these numbers to members or features.
Retrieving this list requires a full or read-only administrator or location administrator auth token with a
scope of `spark-admin:telephony_config_read`.
:param location_id: Return the list of phone numbers for this location within the given organization. The
maximum length is 36.
:type location_id: str
:param phone_number: Filter phone numbers based on the comma-separated list provided in the `phoneNumber`
array.
:type phone_number: list[str]
:param owner_name: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is
255.
:type owner_name: str
:param org_id: List numbers for this organization.
:type org_id: str
:return: Generator yielding :class:`LocationAvailableNumberObject` instances
"""
if org_id is not None:
params['orgId'] = org_id
if phone_number is not None:
params['phoneNumber'] = ','.join(phone_number)
if owner_name is not None:
params['ownerName'] = owner_name
url = self.ep(f'{location_id}/callIntercept/availableNumbers')
return self.session.follow_pagination(url=url, model=AvailableNumber, item_key='phoneNumbers', params=params)
[docs]
def safe_delete_check_before_disabling_calling_location(self, location_id: str,
org_id: str = None) -> SafeDeleteCheckResponse:
"""
Safe Delete Check Before Disabling a Location for Webex Calling
Performs a safe delete check operation to identify any issues that would prevent the calling location from
being disabled. This API helps identify resources that need to be addressed before a calling location can be
successfully disabled.
This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.
:param location_id: Unique identifier for the location to be checked.
:type location_id: str
:param org_id: Organization ID for which the safe delete check operation is being performed.
:type org_id: str
:rtype: :class:`SafeDeleteCheckResponse`
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep(f'{location_id}/actions/precheckForDeletion/invoke')
data = super().post(url, params=params)
r = SafeDeleteCheckResponse.model_validate(data)
return r
[docs]
def get_call_captions_settings(self, location_id: str,
org_id: str = None) -> LocationCallCaptions:
"""
Get the location call captions settings
Retrieve the location's call captions settings.
**NOTE**: The call captions feature is not supported for locations in India.
The call caption feature allows the customer to enable and manage closed captions and transcript functionality
(rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.
This API requires a full, read-only, or location administrator auth token with a scope of
`spark-admin:telephony_config_read`.
:param location_id: Unique identifier for the location.
:type location_id: str
:param org_id: Unique identifier for the organization.
:type org_id: str
:rtype: :class:`LocationCallCaptions`
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep(f'{location_id}/callCaptions')
data = super().get(url, params=params)
r = LocationCallCaptions.model_validate(data)
return r
[docs]
def update_call_captions_settings(self, location_id: str, settings: LocationCallCaptions,
org_id: str = None):
"""
Update the location call captions settings
Update the location's call captions settings.
**NOTE**: The call captions feature is not supported for locations in India.
The call caption feature allows the customer to enable and manage closed captions and transcript functionality
(rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.
This API requires a full or location administrator auth token with a scope of
`spark-admin:telephony_config_write`.
:param location_id: Unique identifier for the location.
:type location_id: str
:param settings: settings to update
:type settings: :class:`LocationCallCaptions`
:param org_id: Unique identifier for the organization.
:type org_id: str
:rtype: None
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
body = settings.update()
url = self.ep(f'{location_id}/callCaptions')
super().put(url, params=params, json=body)