wxc_sdk.telephony package
Telephony types and API (location and organisation settings)
- class wxc_sdk.telephony.NumberListPhoneNumberType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- primary = 'PRIMARY'
- alternate = 'ALTERNATE'
- fax = 'FAX'
- dnis = 'DNIS'
- class wxc_sdk.telephony.TelephonyType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- pstn_number = 'PSTN_NUMBER'
Object is a PSTN number.
- mobile_number = 'MOBILE_NUMBER'
Object is a mobile number.
- class wxc_sdk.telephony.NumberListPhoneNumber(*, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, state: NumberState | None = None, phoneNumberType: NumberListPhoneNumberType | None = None, mainNumber: bool, tollFreeNumber: bool, includedTelephonyTypes: TelephonyType | None = None, mobileNetwork: str | None = None, routingProfile: str | None = None, location: IdAndName, owner: NumberOwner | None = None)[source]
Bases:
ApiModel
Phone Number
- phone_number: str | None
A unique identifier for the PSTN phone number.
- extension: str | None
Extension for a PSTN phone number.
- routing_prefix: str | None
Routing prefix of location.
- esn: str | None
Routing prefix + extension of a person or workspace.
- state: NumberState | None
Phone number’s state.
- phone_number_type: NumberListPhoneNumberType | None
Type of phone number.
- main_number: bool
Indicates if the phone number is used as location clid.
- toll_free_number: bool
Indicates if a phone number is a toll free number.
- included_telephony_types: TelephonyType | None
Indicates Telephony type for the number. example: MOBILE_NUMBER
- mobile_network: str | None
Mobile Network for the number if number is MOBILE_NUMBER. example: mobileNetwork
- routing_profile: str | None
Routing Profile for the number if number is MOBILE_NUMBER. example: AttRtPf
- owner: NumberOwner | None
- class wxc_sdk.telephony.NumberType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- extension = 'EXTENSION'
- number = 'NUMBER'
- class wxc_sdk.telephony.NumberDetails(*, assigned: int | None = None, unAssigned: int | None = None, inActive: int | None = None, extensionOnly: int | None = None, tollFreeNumbers: int | None = None, total: int | None = None, mobileNumber: int | None = None)[source]
Bases:
ApiModel
- assigned: int | None
Count of phone numbers that are in the assigned state.
- un_assigned: int | None
Count of phone numbers which are in the un-assigned state.
- in_active: int | None
Count of phone numbers which are inactive.
- extension_only: int | None
Count of extensions only without phone number.
- toll_free_numbers: int | None
Count of the toll free numbers.
- total: int | None
Total phone numbers and extensions available.
- mobile_number: int | None
Count of phone numbers of type MOBILE_NUMBER only without PSTN_NUMBER and extension.
- class wxc_sdk.telephony.UCMProfile(*, id: str, name: str)[source]
Bases:
ApiModel
- profile_id: str
A unique identifier for the calling UC Manager Profile.
- name: str
Unique name for the calling UC Manager Profile.
- class wxc_sdk.telephony.TestCallRoutingResult(*, language: str | None = None, timeZone: str | None = None, callSourceInfo: CallSourceInfo | None = None, destinationType: DestinationType, routingAddress: str, outsideAccessCode: str | None = None, isRejected: bool, callingLineID: str | None = None, routingProfile: str | None = None, hostedAgent: HostedUserDestination | None = None, hostedFeature: HostedFeatureDestination | None = None, pbxUser: PbxUserDestination | None = None, pstnNumber: PstnNumberDestination | None = None, virtualExtension: VirtualExtensionDestination | None = None, virtualExtensionRange: VirtualExtensionRange | None = None, routeList: RouteListDestination | None = None, featureAccessCode: FeatureAccessCodeDestination | None = None, emergency: EmergencyDestination | None = None, repair: TrunkDestination | None = None, unknownExtension: TrunkDestination | None = None, unknownNumber: TrunkDestination | None = None)[source]
Bases:
ApiModel
- language: str | None
Language for call queue.
- time_zone: str | None
Time zone for the call queue.
- call_source_info: CallSourceInfo | None
This data object is only returned when originatorNumber is specified in the request.
- destination_type: DestinationType
Matching destination type for the call.
- routing_address: str
FAC code if destinationType is FAC. The routing address will be returned for all other destination types.
- outside_access_code: str | None
Outside access code.
- is_rejected: bool
true if the call would be rejected.
- calling_line_id: str | None
Calling line ID (CLID) configured for the calling user. example: +12036680442
- routing_profile: str | None
Routing profile that is used to route network calls. example: AttRtPf
- hosted_user: HostedUserDestination | None
This data object is returned when destinationType is HOSTED_USER.
- hosted_feature: HostedFeatureDestination | None
This data object is returned when destinationType is HOSTED_FEATURE.
- pbx_user: PbxUserDestination | None
This data object is returned when destinationType is PBX_USER.
- pstn_number: PstnNumberDestination | None
This data object is returned when destinationType is PSTN_NUMBER.
- virtual_extension: VirtualExtensionDestination | None
This data object is returned when destinationType is VIRTUAL_EXTENSION.
- virtual_extension_range: VirtualExtensionRange | None
Returned when destinationType is VIRTUAL_EXTENSION_RANGE.
- route_list: RouteListDestination | None
This data object is returned when destinationType is ROUTE_LIST.
- feature_access_code: FeatureAccessCodeDestination | None
This data object is returned when destinationType is FAC.
- emergency: EmergencyDestination | None
This data object is returned when destinationType is EMERGENCY.
- repair: TrunkDestination | None
This data object is returned when destinationType is REPAIR.
- unknown_extension: TrunkDestination | None
This data object is returned when destinationType is UNKNOWN_EXTENSION.
- unknown_number: TrunkDestination | None
This data object is returned when destinationType is UNKNOWN_NUMBER.
- class wxc_sdk.telephony.OriginatorType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- user = 'USER'
User
- trunk = 'TRUNK'
Connection between Webex Calling and the premises.
- class wxc_sdk.telephony.CallSourceType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
The type of call source.
- route_list = 'ROUTE_LIST'
Indicates that the call source is a route list
- dial_pattern = 'DIAL_PATTERN'
Indicates that the call source is a dial pattern.
- unknown_extension = 'UNKNOWN_EXTENSION'
Indicates that the call source extension is unknown.
- unknown_number = 'UNKNOWN_NUMBER'
Indicates that the call source phone number is unknown.
- class wxc_sdk.telephony.CallSourceInfo(*, callSourceType: CallSourceType, routeListName: str | None = None, routeListId: str | None = None, dialPlanName: str | None = None, dialPattern: str | None = None, dialPlanId: str | None = None)[source]
Bases:
ApiModel
This data object is only returned when originatorNumber is specified in the request.
- call_source_type: CallSourceType
The type of call source.
- route_list_name: str | None
When originatorType is “trunk”, originatorId is a valid trunk, this trunk belongs to a route group which is assigned to a route list with the name routeListA, and originatorNumber is a number assigned to routeListA. routeListA is returned here. This element is returned when callSourceType is ROUTE_LIST.
- route_list_id: str | None
route list id
- dial_plan_name: str | None
When originatorType is “trunk”, originatorId is a valid trunk with name trunkA, trunkA belongs to a route group which is assigned to a route list with name routeListA, trunkA is also assigned to dialPlanA as routing choice, dialPlanA has dialPattern xxxx assigned. If the originatorNumber match the dialPattern xxxx, dialPlanA is returned. This element is returned when callSourceType is DIAL_PATTERN.
- dial_pattern: str | None
When originatorType is “trunk”, originatorId is a valid trunk with the name trunkA, trunkA belongs to a route group which is assigned to a route list with the name routeListA, trunkA is also assigned to dialPlanA as routing choice, dialPlanA has dialPattern xxxx assigned. If the originatorNumber match the dialPattern xxxx, dialPattern xxxx is returned. This element is returned when callSourceType is DIAL_PATTERN.
- dial_plan_id: str | None
dial plan id
- class wxc_sdk.telephony.DestinationType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
Matching destination type for the call.
- hosted_agent = 'HOSTED_AGENT'
Matching destination is a person or workspace with details in the hosted_user field.
- hosted_feature = 'HOSTED_FEATURE'
Matching destination is a calling feature like auto-attendant or hunt group with details in the hostedFeature field.
- pbx_user = 'PBX_USER'
Matching destination routes into a separate PBX with details in the pbxUser field.
- pstn_number = 'PSTN_NUMBER'
Matching destination routes into a PSTN phone number with details in the pstnNumber field.
- virtual_extension = 'VIRTUAL_EXTENSION'
Matching destination routes into a virtual extension with details in the virtualExtension field.
- virtual_extension_range = 'VIRTUAL_EXTENSION_RANGE'
Matching destination routes into a virtual extension range with details in the virtualExtensionRange field.
- route_list = 'ROUTE_LIST'
Matching destination routes into a route list with details in the routeList field.
- fac = 'FAC'
Matching destination routes into a feature access code (FAC) with details in the featureAccessCode field.
- emergency = 'EMERGENCY'
Matching destination routes into an emergency service like Red Sky, with details in the emergency field.
- repair = 'REPAIR'
The route is in a repair state with routing choice details in the repair field.
- unknown_extension = 'UNKNOWN_EXTENSION'
Target extension is unknown with routing choice details in the unknownExtension field.
- unknown_number = 'UNKNOWN_NUMBER'
The target phone number is unknown with routing choice details in the unknownNumber field.
- class wxc_sdk.telephony.LocationAndNumbers(*, locationName: str, locationId: str, phoneNumber: str | None = None, extension: str | None = None)[source]
Bases:
ApiModel
- location_name: str
- location_id: str
- phone_number: str | None
- extension: str | None
- class wxc_sdk.telephony.HostedUserDestination(*, locationName: str, locationId: str, phoneNumber: str | None = None, extension: str | None = None, id: str, type: UserType, firstName: str, lastName: str)[source]
Bases:
LocationAndNumbers
This data object is returned when destinationType is HOSTED_USER.
- hu_id: str
person/workspace’s id
- first_name: str
Person or workspace’s first name.
- last_name: str
Person or workspace’s last name.
- class wxc_sdk.telephony.ServiceType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- auto_attendant = 'AUTO_ATTENDANT'
Indicates that this destination is an auto attendant.
- broadworks_anywhere = 'BROADWORKS_ANYWHERE'
Indicates that this destination is the Office (Broadworks) Anywhere feature.
- call_queue = 'CALL_QUEUE'
Indicates that this destination is the Call Queue feature.
- contact_center_link = 'CONTACT_CENTER_LINK'
Indicates that this destination is the Contact Center Link feature.
- group_paging = 'GROUP_PAGING'
Indicates that this destination is the Group Paging feature.
- hunt_group = 'HUNT_GROUP'
Indicates that this destination is the Hunt Group feature.
- voice_messaging = 'VOICE_MESSAGING'
Indicates that this destination is the Voice Messaging feature.
- voice_mail_group = 'VOICE_MAIL_GROUP'
Indicates that this destination is the Voice Mail Group feature.
- class wxc_sdk.telephony.HostedFeatureDestination(*, locationName: str, locationId: str, phoneNumber: str | None = None, extension: str | None = None, type: ServiceType, name: str, id: str)[source]
Bases:
LocationAndNumbers
This data object is returned when destinationType is HOSTED_FEATURE
- service_type: ServiceType
- name: str
service instance name
- service_instance_id: str
service instance id
- class wxc_sdk.telephony.TrunkDestination(*, trunkName: str | None = None, trunkId: str | None = None, routeGroupName: str | None = None, routeGroupId: str | None = None, trunkLocationName: str | None = None, trunkLocationId: str | None = None)[source]
Bases:
ApiModel
- trunk_name: str | None
- trunk_id: str | None
- route_group_name: str | None
- route_group_id: str | None
- trunk_location_name: str | None
location of the trunk, required if trunkName is returned
- trunk_location_id: str | None
location id of the trunk, required if trunkName is returned
- class wxc_sdk.telephony.PbxUserDestination(*, trunkName: str | None = None, trunkId: str | None = None, routeGroupName: str | None = None, routeGroupId: str | None = None, trunkLocationName: str | None = None, trunkLocationId: str | None = None, dialPlanName: str, dialPlanId: str, dialPattern: str)[source]
Bases:
TrunkDestination
This data object is returned when destinationType is PBX_USER.
- dial_plan_name: str
the dial plan name that the called string matches
- dial_plan_id: str
- dial_pattern: str
the dial pattern that the called string matches
- class wxc_sdk.telephony.PstnNumberDestination(*, trunkName: str | None = None, trunkId: str | None = None, routeGroupName: str | None = None, routeGroupId: str | None = None, trunkLocationName: str | None = None, trunkLocationId: str | None = None)[source]
Bases:
TrunkDestination
- class wxc_sdk.telephony.VirtualExtensionDestination(*, trunkName: str | None = None, trunkId: str | None = None, routeGroupName: str | None = None, routeGroupId: str | None = None, trunkLocationName: str | None = None, trunkLocationId: str | None = None, locationName: str, locationId: str, phoneNumber: str | None = None, extension: str | None = None, id: str, firstName: str, lastName: str, displayName: str)[source]
Bases:
LocationAndNumbers
,TrunkDestination
- virtual_extension_id: str
Virtual extension ID.
- first_name: str
Virtual extension display first name.
- last_name: str
Virtual extension display last name.
- display_name: str
Virtual extension display name.
- class wxc_sdk.telephony.RouteListDestination(*, id: str, name: str, routeGroupName: str, routeGroupId: str, locationName: str, locationId: str)[source]
Bases:
ApiModel
This data object is returned when destinationType is ROUTE_LIST.
- route_list_id: str
- name: str
- route_group_name: str
- route_group_id: str
- location_name: str
- location_id: str
- class wxc_sdk.telephony.FeatureAccessCodeDestination(*, code: str, name: str)[source]
Bases:
ApiModel
This data object is returned when destinationType is FAC.
- code: str
- name: str
- class wxc_sdk.telephony.EmergencyDestination(*, trunkName: str | None = None, trunkId: str | None = None, routeGroupName: str | None = None, routeGroupId: str | None = None, trunkLocationName: str | None = None, trunkLocationId: str | None = None, isRedSky: bool)[source]
Bases:
TrunkDestination
This data object is returned when destinationType is EMERGENCY.
- is_red_sky: bool
- class wxc_sdk.telephony.DeviceType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- mpp = 'MPP'
- ata = 'ATA'
- generic_sip = 'GENERIC_SIP'
- esim = 'ESIM'
- desk_phone = 'DESK_PHONE'
- class wxc_sdk.telephony.DeviceManufacturer(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- cisco = 'CISCO'
- third_party = 'THIRD_PARTY'
- class wxc_sdk.telephony.DeviceManagedBy(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- cisco = 'CISCO'
- customer = 'CUSTOMER'
- partner = 'PARTNER'
- class wxc_sdk.telephony.OnboardingMethod(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- mac_address = 'MAC_ADDRESS'
- activation_code = 'ACTIVATION_CODE'
- no_method = 'NONE'
- class wxc_sdk.telephony.SupportedDevice(*, model: str, displayName: str, type: DeviceType, manufacturer: DeviceManufacturer, managedBy: DeviceManagedBy, supportedFor: list[UserType], onboardingMethod: list[OnboardingMethod], allowConfigureLayoutEnabled: bool, numberOfLinePorts: int, kemSupportEnabled: bool, kemModuleCount: int | None = None, kemModuleType: list[str] | None = None, upgradeChannelEnabled: bool | None = None, defaultUpgradeChannel: str | None = None, additionalPrimaryLineAppearancesEnabled: bool | None = None, basicEmergencyNomadicEnabled: bool | None = None, customizedBehaviorsEnabled: bool | None = None, allowConfigurePortsEnabled: bool | None = None, customizableLineLabelEnabled: bool | None = None, touchScreenPhone: bool | None = None, supportsLinePortReorderingEnabled: bool | None = None, portNumberSupportEnabled: bool | None = None, t38Enabled: bool | None = None, callDeclinedEnabled: bool | None = None, deviceSettingsConfiguration: DeviceSettingsConfiguration | None = None)[source]
Bases:
ApiModel
- model: str
Model name of the device.
- display_name: str
Display name of the device.
- device_type: DeviceType
Type of the device.
- manufacturer: DeviceManufacturer
Manufacturer of the device.
- managed_by: DeviceManagedBy
Users who manage the device.
- onboarding_method: list[OnboardingMethod]
Onboarding method.
- allow_configure_layout_enabled: bool
Enables / Disables layout configuration for devices.
- number_of_line_ports: int
Number of port lines.
- kem_support_enabled: bool
Indicates whether Kem support is enabled or not.
- kem_module_count: int | None
Module count.
- kem_module_type: list[str] | None
Key expansion module type of the device.
- upgrade_channel_enabled: bool | None
Enables / Disables the upgrade channel.
- default_upgrade_channel: str | None
The default upgrade channel.
- additional_primary_line_appearances_enabled: bool | None
Enables / disables the additional primary line appearances.
- basic_emergency_nomadic_enabled: bool | None
Enables / disables Basic emergency nomadic.
- customized_behaviors_enabled: bool | None
Enables / disables customized behavior support on devices
- allow_configure_ports_enabled: bool | None
Enables / disables configuring port support on device.
- customizable_line_label_enabled: bool | None
Enables / disables customizable line label.
- touch_screen_phone: bool | None
Supports touch screen on device.
- supports_line_port_reordering_enabled: bool | None
- port_number_support_enabled: bool | None
- t38_enabled: bool | None
- call_declined_enabled: bool | None
- device_settings_configuration: DeviceSettingsConfiguration | None
Device settings configuration.
- class wxc_sdk.telephony.AnnouncementLanguage(*, name: str | None = None, code: str | None = None)[source]
Bases:
ApiModel
- name: str | None
Language name.
- code: str | None
Language Code
- class wxc_sdk.telephony.TelephonyApi(session: RestSession)[source]
Bases:
ApiChild
The telephony settings (features) API.
- access_codes: LocationAccessCodesApi
access or authentication codes at location level
- announcements_repo: AnnouncementsRepositoryApi
- auto_attendant: AutoAttendantApi
- call_intercept: LocationInterceptApi
location call intercept settings
- call_recording: CallRecordingSettingsApi
- callpark: CallParkApi
- callpark_extension: CallparkExtensionApi
- callqueue: CallQueueApi
- dect_devices: DECTDevicesApi
- base = 'telephony/config'
- devices: TelephonyDevicesApi
WxC device operations
- huntgroup: HuntGroupApi
- location: TelephonyLocationApi
location specific settings
- locations: TelephonyLocationApi
- organisation_voicemail: OrganisationVoicemailSettingsAPI
organisation voicemail settings
- permissions_out: OutgoingPermissionsApi
- pickup: CallPickupApi
- prem_pstn: PremisePstnApi
- schedules: ScheduleApi
- virtual_lines: VirtualLinesApi
- voicemail_groups: VoicemailGroupsApi
- voicemail_rules: VoicemailRulesApi
- voice_messaging: VoiceMessagingApi
- voiceportal: VoicePortalApi
- phone_numbers(location_id: str | None = None, phone_number: str | None = None, available: bool | None = None, order: str | None = None, owner_name: str | None = None, owner_id: str | None = None, owner_type: OwnerType | None = None, extension: str | None = None, number_type: NumberType | None = None, phone_number_type: NumberListPhoneNumberType | None = None, state: NumberState | None = None, details: bool | None = None, toll_free_numbers: bool | None = None, restricted_non_geo_numbers: bool | None = None, included_telephony_type: TelephonyType | None = None, org_id: str | None = None, **params) Generator[NumberListPhoneNumber, None, None] [source]
Get Phone Numbers for an Organization with given criteria.
List all the phone numbers for the given organization along with the status and owner (if any).
PSTN phone numbers are associated with a specific location and can be active/inactive and assigned/unassigned. The owner is the person, workspace, or feature to which the number is assigned. Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
- Parameters:
location_id (str) – Return the list of phone numbers for this location within the given organization.
phone_number (str) – Search for this phone number.
available (bool) – Search among the available phone numbers. This parameter cannot be used along with owner_type parameter when set to true.
order (str) – Sort the list of phone numbers based on the following:lastName,dn,extension. Default sort will be based on number and extension in an Ascending order
owner_name (str) – Return the list of phone numbers that is owned by given owner name. Maximum length is 255.
owner_id (str) – Returns only the matched number/extension entries assigned to the feature with specified uuid/broadsoftId.
owner_type (OwnerType) – Returns the list of phone numbers that are of given owner_type.
extension (str) – Returns the list of PSTN phone numbers with given extension.
number_type (NumberType) – Returns the filtered list of PSTN phone numbers that contains given type of numbers. This parameter cannot be used along with available or state.
phone_number_type (NumberListPhoneNumberType) – Returns the filtered list of PSTN phone numbers that are of given phoneNumberType.
state (NumberState) – Returns the list of PSTN phone numbers with matching state.
details (bool) – Returns the overall count of the PSTN phone numbers along with other details for given organization.
toll_free_numbers (bool) – Returns the list of toll free phone numbers.
restricted_non_geo_numbers (bool) – Returns the list of restricted non geographical numbers.
included_telephony_type (TelephonyType) – Returns the list of phone numbers that are of given includedTelephonyType. By default if this query parameter is not provided, it will list both PSTN and Mobile Numbers. Possible input values are PSTN_NUMBER, MOBILE_NUMBER.
org_id (str) – List numbers for this organization.
- Returns:
yields
NumberListPhoneNumber
instances
- phone_number_details(org_id: str | None = None) NumberDetails [source]
get summary (counts) of phone numbers
- Parameters:
org_id (str) – detaild for numbers in this organization.
- Returns:
phone number details
- Return type:
- validate_extensions(extensions: list[str]) ValidateExtensionsResponse [source]
Validate the List of Extensions
Validate the List of Extensions. Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
- Parameters:
extensions (list[str]) – Array of Strings of ID of Extensions.
- Returns:
validation response
- Return type:
- validate_phone_numbers(phone_numbers: list[str], org_id: str | None = None) ValidatePhoneNumbersResponse [source]
Validate the list of phone numbers in an organization. Each phone number’s availability is indicated in the response.
Each location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service.
Validating a phone number in an organization requires a full administrator auth token with a scope of spark-admin:telephony_config_write.
- Parameters:
phone_numbers (list[str]) – List of phone numbers to be validated.
org_id (str) – Organization of the Route Group.
- Returns:
validation result
- Return type:
- ucm_profiles(org_id: str | None = None) list[UCMProfile] [source]
Read the List of UC Manager Profiles
List all calling UC Manager Profiles for the organization.
UC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex Teams (Unified CM).
The UC Manager Profile has an organization-wide default and may be overridden for individual persons, although currently only setting at a user level is supported by Webex APIs.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:people_read as this API is designed to be used in conjunction with calling behavior at the user level.
- Parameters:
org_id (str) – List manager profiles in this organization.
- Returns:
list of
UCMProfile
- route_choices(route_group_name: str | None = None, trunk_name: str | None = None, order: str | None = None, org_id: str | None = None) Generator[RouteIdentity, None, None] [source]
List all Routes for the organization.
Trunk and Route Group qualify as Route. Trunks and Route Groups provide you the ability to configure Webex Calling to manage calls between Webex Calling hosted users and premises PBX(s) users. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
- Parameters:
route_group_name – Return the list of route identities matching the route group name.
trunk_name – Return the list of route identities matching the trunk name.
order – Order the route identities according to the designated fields. Available sort fields: routeName, routeType.
org_id – List route identities for this organization.
- Returns:
- test_call_routing(originator_id: str, originator_type: OriginatorType, destination: str, originator_number: str | None = None, org_id: str | None = None) TestCallRoutingResult [source]
Validates that an incoming call can be routed.
Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location. A dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns. Specific dial patterns can be defined as part of your dial plan.
Test call routing requires a full administrator auth token with a scope of spark-admin:telephony_config_write.
- Parameters:
originator_id (str) – This element is used to identify the originating party. It can be a person ID or a trunk ID.
originator_type (
OriginatorType
) – This element is used to identify if the originatorId is of type PEOPLE or TRUNK.destination (str) – This element specifies called party. It can be any dialable string, for example, an ESN number, E.164 number, hosted user DN, extension, extension with location code, URL, FAC code.
originator_number (str) – Only used when originatorType is TRUNK. The originatorNumber can be a phone number or URI.
org_id (str) – Organization in which we are validating a call routing.
- Returns:
call routing test result
- Return type:
- supported_devices(org_id: str | None = None) SupportedDevices [source]
Gets the list of supported devices for an organization location.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
- Parameters:
org_id – List supported devices for an organization
- Returns:
List of supported devices
- device_settings(org_id: str | None = None) DeviceCustomization [source]
Get device override settings for an organization.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
- Parameters:
org_id (str) – List supported devices for an organization location.
- Returns:
device customization response
- Return type:
- read_list_of_announcement_languages() list[AnnouncementLanguage] [source]
List all languages supported by Webex Calling for announcements and voice prompts. Retrieving announcement languages requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
documentation: https://developer.webex.com/docs/api/v1/webex-calling-organization-settings/read-the-list-of -announcement-languages
- class wxc_sdk.telephony.DeviceSettingsConfiguration(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- webex_calling_device_configuration = 'WEBEX_CALLING_DEVICE_CONFIGURATION'
Devices which supports Webex Calling Device Settings Configuration.
- webex_device_configuration = 'WEBEX_DEVICE_CONFIGURATION'
Devices which supports Webex Device Settings Configuration.
- none_ = 'NONE'
Devices does not support any configuration.
- class wxc_sdk.telephony.SupportedDevices(*, upgradeChannelList: list[str] | None = None, devices: list[SupportedDevice] | None = None)[source]
Bases:
ApiModel
- upgrade_channel_list: list[str] | None
- devices: list[SupportedDevice] | None
Subpackages
- wxc_sdk.telephony.announcements_repo package
- wxc_sdk.telephony.call_recording package
CallRecordingInfo
CallRecordingTermsOfService
OrgComplianceAnnouncement
LocationComplianceAnnouncement
CallRecordingSettingsApi
CallRecordingSettingsApi.read()
CallRecordingSettingsApi.update()
CallRecordingSettingsApi.read_terms_of_service()
CallRecordingSettingsApi.update_terms_of_service()
CallRecordingSettingsApi.read_org_compliance_announcement()
CallRecordingSettingsApi.update_org_compliance_announcement()
CallRecordingSettingsApi.read_location_compliance_announcement()
CallRecordingSettingsApi.update_location_compliance_announcement()
CallRecordingSettingsApi.base
- wxc_sdk.telephony.callqueue package
CallBounce
DistinctiveRing
CallQueueCallPolicies
OverflowAction
OverflowSetting
OverflowSetting.action
OverflowSetting.send_to_voicemail
OverflowSetting.transfer_number
OverflowSetting.is_transfer_number_set
OverflowSetting.overflow_after_wait_enabled
OverflowSetting.overflow_after_wait_time
OverflowSetting.play_overflow_greeting_enabled
OverflowSetting.greeting
OverflowSetting.audio_announcement_files
OverflowSetting.default()
WaitMode
WaitMessageSetting
WaitMessageSetting.enabled
WaitMessageSetting.wait_mode
WaitMessageSetting.handling_time
WaitMessageSetting.default_handling_time
WaitMessageSetting.queue_position
WaitMessageSetting.high_volume_message_enabled
WaitMessageSetting.estimated_waiting_time
WaitMessageSetting.callback_option_enabled
WaitMessageSetting.minimum_estimated_callback_time
WaitMessageSetting.international_callback_enabled
WaitMessageSetting.play_updated_estimated_wait_message
WaitMessageSetting.default()
AudioSource
WelcomeMessageSetting
ComfortMessageSetting
MohMessageSetting
ComfortMessageBypass
QueueSettings
QueueSettings.queue_size
QueueSettings.call_offer_tone_enabled
QueueSettings.reset_call_statistics_enabled
QueueSettings.overflow
QueueSettings.wait_message
QueueSettings.welcome_message
QueueSettings.comfort_message
QueueSettings.moh_message
QueueSettings.comfort_message_bypass
QueueSettings.whisper_message
QueueSettings.default()
CallQueue
CallQueueApi
CQRoutingType
- Submodules
- wxc_sdk.telephony.dect_devices package
DECTNetworkModel
DECTNetworkDetail
DECTNetworkDetail.id
DECTNetworkDetail.name
DECTNetworkDetail.display_name
DECTNetworkDetail.chain_id
DECTNetworkDetail.model
DECTNetworkDetail.default_access_code_enabled
DECTNetworkDetail.default_access_code
DECTNetworkDetail.number_of_base_stations
DECTNetworkDetail.number_of_handsets_assigned
DECTNetworkDetail.number_of_lines
DECTNetworkDetail.location
BaseStationResult
BaseStationResponse
BaseStationsResponse
DECTHandsetLine
DECTHandsetLine.member_id
DECTHandsetLine.first_name
DECTHandsetLine.last_name
DECTHandsetLine.external
DECTHandsetLine.extension
DECTHandsetLine.routing_prefix
DECTHandsetLine.esn
DECTHandsetLine.last_registration_time
DECTHandsetLine.host_ip
DECTHandsetLine.remote_ip
DECTHandsetLine.location
DECTHandsetLine.member_type
Handset
BaseStationDetail
DECTHandsetItem
DECTHandsetList
UsageType
DECTDevicesApi
DECTDevicesApi.create_dect_network()
DECTDevicesApi.list_dect_networks()
DECTDevicesApi.dect_network_details()
DECTDevicesApi.update_dect_network()
DECTDevicesApi.update_dect_network_settings()
DECTDevicesApi.delete_dect_network()
DECTDevicesApi.create_base_stations()
DECTDevicesApi.list_base_stations()
DECTDevicesApi.base_station_details()
DECTDevicesApi.delete_bulk_base_stations()
DECTDevicesApi.delete_base_station()
DECTDevicesApi.add_a_handset()
DECTDevicesApi.list_handsets()
DECTDevicesApi.handset_details()
DECTDevicesApi.update_handset()
DECTDevicesApi.delete_handset()
DECTDevicesApi.delete_handsets()
DECTDevicesApi.dect_networks_associated_with_person()
DECTDevicesApi.dect_networks_associated_with_workspace()
DECTDevicesApi.dect_networks_associated_with_virtual_line()
DECTDevicesApi.available_members()
DECTDevicesApi.base
- wxc_sdk.telephony.devices package
DectDevice
MemberCommon
MemberCommon.member_id
MemberCommon.member_type
MemberCommon.first_name
MemberCommon.last_name
MemberCommon.phone_number
MemberCommon.extension
MemberCommon.routingPrefix
MemberCommon.esn
MemberCommon.t38_fax_compression_enabled
MemberCommon.line_type
MemberCommon.allow_call_decline_enabled
MemberCommon.location
DeviceMember
DeviceMembersResponse
AvailableMember
MACState
MACStatus
MACValidationResponse
TelephonyDevicesApi
TelephonyDevicesApi.details()
TelephonyDevicesApi.members()
TelephonyDevicesApi.update_members()
TelephonyDevicesApi.available_members()
TelephonyDevicesApi.apply_changes()
TelephonyDevicesApi.device_settings()
TelephonyDevicesApi.update_device_settings()
TelephonyDevicesApi.dect_devices()
TelephonyDevicesApi.validate_macs()
TelephonyDevicesApi.create_line_key_template()
TelephonyDevicesApi.list_line_key_templates()
TelephonyDevicesApi.line_key_template_details()
TelephonyDevicesApi.modify_line_key_template()
TelephonyDevicesApi.delete_line_key_template()
TelephonyDevicesApi.preview_apply_line_key_template()
TelephonyDevicesApi.get_device_layout()
TelephonyDevicesApi.modify_device_layout()
TelephonyDevicesApi.get_person_device_settings()
TelephonyDevicesApi.update_person_device_settings()
TelephonyDevicesApi.get_workspace_device_settings()
TelephonyDevicesApi.update_workspace_device_settings()
TelephonyDevicesApi.base
LineKeyType
ProgrammableLineKey
LineKeyTemplate
TelephonyDeviceDetails
TelephonyDeviceDetails.manufacturer
TelephonyDeviceDetails.owner
TelephonyDeviceDetails.proxy
TelephonyDeviceDetails.managed_by
TelephonyDeviceDetails.id
TelephonyDeviceDetails.ip
TelephonyDeviceDetails.mac
TelephonyDeviceDetails.model
TelephonyDeviceDetails.activation_state
TelephonyDeviceDetails.description
TelephonyDeviceDetails.upgrade_channel_enabled
ActivationState
TelephonyDeviceOwner
TelephonyDeviceProxy
LayoutMode
KemModuleType
KemKey
DeviceLayout
DeviceSettings
- wxc_sdk.telephony.jobs package
StepExecutionStatus
JobExecutionStatus
StartJobResponse
StartJobResponse.name
StartJobResponse.id
StartJobResponse.tracking_id
StartJobResponse.source_user_id
StartJobResponse.source_customer_id
StartJobResponse.target_customer_id
StartJobResponse.instance_id
StartJobResponse.job_execution_status
StartJobResponse.latest_execution_status
StartJobResponse.location_customizations_enabled
StartJobResponse.target
StartJobResponse.location_id
StartJobResponse.location_name
StartJobResponse.percentage_complete
StartJobResponse.device_count
JobErrorMessage
JobError
JobErrorItem
JobsApi
DeviceSettingsJobsApi
NumberItem
MoveNumberCounts
NumberJob
NumberJob.id
NumberJob.name
NumberJob.job_type
NumberJob.tracking_id
NumberJob.source_user_id
NumberJob.source_customer_id
NumberJob.target_customer_id
NumberJob.instance_id
NumberJob.job_execution_status
NumberJob.latest_execution_status
NumberJob.operation_type
NumberJob.source_location_id
NumberJob.target_location_id
NumberJob.source_location_name
NumberJob.target_location_name
NumberJob.counts
ErrorMessageObject
ErrorObject
ManageNumberErrorItem
ManageNumbersJobsApi
InitiateMoveNumberJobsBody
ApplyLineKeyTemplatesJobsApi
LineKeyTemplateAdvisoryTypes
ApplyLineKeyTemplateJobDetails
ApplyLineKeyTemplateJobDetails.name
ApplyLineKeyTemplateJobDetails.id
ApplyLineKeyTemplateJobDetails.tracking_id
ApplyLineKeyTemplateJobDetails.source_user_id
ApplyLineKeyTemplateJobDetails.source_customer_id
ApplyLineKeyTemplateJobDetails.target_customer_id
ApplyLineKeyTemplateJobDetails.instance_id
ApplyLineKeyTemplateJobDetails.job_execution_status
ApplyLineKeyTemplateJobDetails.latest_execution_status
ApplyLineKeyTemplateJobDetails.percentage_complete
ApplyLineKeyTemplateJobDetails.updated_count
ApplyLineKeyTemplateJobDetails.advisory_count
RebuildPhonesJobsApi
- wxc_sdk.telephony.location package
CallingLineId
PSTNConnection
TelephonyLocation
TelephonyLocation.location_id
TelephonyLocation.name
TelephonyLocation.announcement_language
TelephonyLocation.calling_line_id
TelephonyLocation.connection
TelephonyLocation.external_caller_id_name
TelephonyLocation.user_limit
TelephonyLocation.p_access_network_info
TelephonyLocation.outside_dial_digit
TelephonyLocation.routing_prefix
TelephonyLocation.charge_number
TelephonyLocation.default_domain
TelephonyLocation.e911_setup_required
TelephonyLocation.enforce_outside_dial_digit
TelephonyLocation.subscription_id
TelephonyLocationApi
TelephonyLocationApi.intercept
TelephonyLocationApi.internal_dialing
TelephonyLocationApi.moh
TelephonyLocationApi.number
TelephonyLocationApi.voicemail
TelephonyLocationApi.receptionist_contacts_directory
TelephonyLocationApi.generate_password()
TelephonyLocationApi.validate_extensions()
TelephonyLocationApi.base
TelephonyLocationApi.details()
TelephonyLocationApi.enable_for_calling()
TelephonyLocationApi.list()
TelephonyLocationApi.update()
TelephonyLocationApi.change_announcement_language()
TelephonyLocationApi.device_settings()
- Submodules
- wxc_sdk.telephony.prem_pstn package
- wxc_sdk.telephony.virtual_line package
VirtualLine
VirtualLine.id
VirtualLine.last_name
VirtualLine.first_name
VirtualLine.display_name
VirtualLine.caller_id_last_name
VirtualLine.caller_id_first_name
VirtualLine.caller_id_number
VirtualLine.external_caller_id_name_policy
VirtualLine.custom_external_caller_id_name
VirtualLine.number
VirtualLine.location
VirtualLine.number_of_devices_assigned
VirtualLine.billing_plan
VirtualLine.directory_search_enabled
VirtualLine.announcement_language
VirtualLine.time_zone
VirtualLine.devices
VirtualLinesApi
VirtualLinesApi.call_bridge
VirtualLinesApi.call_intercept
VirtualLinesApi.call_recording
VirtualLinesApi.call_waiting
VirtualLinesApi.caller_id
VirtualLinesApi.forwarding
VirtualLinesApi.permissions_in
VirtualLinesApi.permissions_out
VirtualLinesApi.create()
VirtualLinesApi.base
VirtualLinesApi.delete()
VirtualLinesApi.details()
VirtualLinesApi.update()
VirtualLinesApi.get_phone_number()
VirtualLinesApi.update_directory_search()
VirtualLinesApi.assigned_devices()
VirtualLinesApi.dect_networks()
VirtualLinesApi.list()
VirtualLineNumber
VirtualLineLocation
VirtualLineNumberPhoneNumber
VirtualLineDevices
Submodules
- wxc_sdk.telephony.access_codes module
- wxc_sdk.telephony.autoattendant module
Dialing
MenuKey
AutoAttendantAction
AutoAttendantAction.transfer_without_prompt
AutoAttendantAction.transfer_with_prompt
AutoAttendantAction.transfer_to_operator
AutoAttendantAction.name_dialing
AutoAttendantAction.extension_dialing
AutoAttendantAction.repeat_menu
AutoAttendantAction.exit
AutoAttendantAction.transfer_to_mailbox
AutoAttendantAction.return_to_previous_menu
AutoAttendantAction.play_announcement
AutoAttendantKeyConfiguration
AutoAttendantMenu
AutoAttendant
AutoAttendant.auto_attendant_id
AutoAttendant.name
AutoAttendant.location_name
AutoAttendant.location_id
AutoAttendant.enabled
AutoAttendant.phone_number
AutoAttendant.extension
AutoAttendant.routingPrefix
AutoAttendant.esn
AutoAttendant.toll_free_number
AutoAttendant.first_name
AutoAttendant.last_name
AutoAttendant.alternate_numbers
AutoAttendant.language
AutoAttendant.language_code
AutoAttendant.business_schedule
AutoAttendant.holiday_schedule
AutoAttendant.extension_dialing
AutoAttendant.name_dialing
AutoAttendant.time_zone
AutoAttendant.business_hours_menu
AutoAttendant.after_hours_menu
AutoAttendant.create_or_update()
AutoAttendant.create()
AutoAttendantApi
- wxc_sdk.telephony.callpark module
- wxc_sdk.telephony.callpark_extension module
- wxc_sdk.telephony.callpickup module
- wxc_sdk.telephony.calls module
CallType
TelephonyParty
RedirectReason
Redirection
Recall
RecordingState
Personality
CallState
TelephonyCall
TelephonyCall.id_call_id
TelephonyCall.id_id
TelephonyCall.call_id
TelephonyCall.call_session_id
TelephonyCall.personality
TelephonyCall.state
TelephonyCall.remote_party
TelephonyCall.appearance
TelephonyCall.created
TelephonyCall.answered
TelephonyCall.redirections
TelephonyCall.recall
TelephonyCall.recording_state
TelephonyCall.disconnected
TelephonyEventData
TelephonyEvent
DialResponse
RejectAction
HistoryType
CallHistoryRecord
ParkedAgainst
CallInfo
CallsApi
CallsApi.dial()
CallsApi.answer()
CallsApi.reject()
CallsApi.hangup()
CallsApi.hold()
CallsApi.resume()
CallsApi.divert()
CallsApi.transfer()
CallsApi.park()
CallsApi.retrieve()
CallsApi.start_recording()
CallsApi.stop_recording()
CallsApi.pause_recording()
CallsApi.resume_recording()
CallsApi.transmit_dtmf()
CallsApi.push()
CallsApi.pickup()
CallsApi.barge_in()
CallsApi.list_calls()
CallsApi.call_details()
CallsApi.call_history()
CallsApi.base
- wxc_sdk.telephony.forwarding module
- wxc_sdk.telephony.hg_and_cq module
HGandCQ
HGandCQ.name
HGandCQ.id
HGandCQ.location_name
HGandCQ.location_id
HGandCQ.phone_number
HGandCQ.extension
HGandCQ.routingPrefix
HGandCQ.esn
HGandCQ.calling_line_id_policy
HGandCQ.calling_line_id_phone_number
HGandCQ.alternate_number_settings
HGandCQ.enabled
HGandCQ.toll_free_number
HGandCQ.language
HGandCQ.language_code
HGandCQ.first_name
HGandCQ.last_name
HGandCQ.time_zone
HGandCQ.agents
HGandCQ.cpapi_id
HGandCQ.bc_id
HGandCQ.create_or_update()
Policy
Agent
AlternateNumberSettings
CallingLineIdPolicy
- wxc_sdk.telephony.huntgroup module
- wxc_sdk.telephony.organisation_vm module
- wxc_sdk.telephony.paging module
PagingApi
Paging
Paging.paging_id
Paging.enabled
Paging.name
Paging.phone_number
Paging.extension
Paging.routingPrefix
Paging.esn
Paging.toll_free_number
Paging.language
Paging.language_code
Paging.first_name
Paging.last_name
Paging.originator_caller_id_enabled
Paging.originators
Paging.targets
Paging.location_name
Paging.location_id
Paging.create_or_update()
Paging.create()
PagingAgent
- wxc_sdk.telephony.pnc module
- wxc_sdk.telephony.vm_rules module
- wxc_sdk.telephony.voice_messaging module
- wxc_sdk.telephony.voicemail_groups module
VoicemailGroup
VoicemailGroupDetail
VoicemailGroupDetail.group_id
VoicemailGroupDetail.name
VoicemailGroupDetail.phone_number
VoicemailGroupDetail.extension
VoicemailGroupDetail.routingPrefix
VoicemailGroupDetail.esn
VoicemailGroupDetail.toll_free_number
VoicemailGroupDetail.first_name
VoicemailGroupDetail.last_name
VoicemailGroupDetail.passcode
VoicemailGroupDetail.enabled
VoicemailGroupDetail.language_code
VoicemailGroupDetail.greeting
VoicemailGroupDetail.greeting_uploaded
VoicemailGroupDetail.greeting_description
VoicemailGroupDetail.message_storage
VoicemailGroupDetail.notifications
VoicemailGroupDetail.fax_message
VoicemailGroupDetail.transfer_to_number
VoicemailGroupDetail.email_copy_of_message
VoicemailGroupDetail.voice_message_forwarding_enabled
VoicemailGroupDetail.time_zone
VoicemailGroupDetail.create()
VoicemailGroupDetail.json_for_create()
VoicemailGroupDetail.json_for_update()
VoicemailGroupsApi
- wxc_sdk.telephony.voiceportal module
VoicePortalSettings
FailedAttempts
ExpirePasscode
PasscodeRules
PasscodeRules.expire_passcode
PasscodeRules.failed_attempts
PasscodeRules.block_previous_passcodes
PasscodeRules.block_repeated_digits
PasscodeRules.block_contiguous_sequences
PasscodeRules.length
PasscodeRules.block_reversed_user_number_enabled
PasscodeRules.block_user_number_enabled
PasscodeRules.block_repeated_patterns_enabled
PasscodeRules.block_reversed_old_passcode_enabled
VoicePortalApi