wxc_sdk.me package

Call Settings For Me

Call settings for me APIs allow a person to read or modify their settings.

class wxc_sdk.me.MeSettingsApi(session: RestSession)[source]

Bases: ApiChild

Call Settings For Me

Call settings for me APIs allow a person to read or modify their settings.

Viewing settings requires a user auth token with a scope of spark:telephony_config_read.

Configuring settings requires a user auth token with a scope of spark:telephony_config_write.

__init__(session: RestSession)[source]
anon_calls: MeAnonCallsApi
barge: MeBargeApi
call_block: MeCallBlockApi
call_center: MeCallCenterApi
call_notify: MeCallNotifyApi
call_park: MeCallParkApi
call_pickup: MeCallPickupApi
call_policies: MeCallPoliciesApi
call_waiting: MeCallWaitingApi
caller_id: MeCallerIdApi
base = 'telephony/config/people/me'
dnd: MeDNDApi
endpoints: MeEndpointsApi
executive: MeExecutiveApi
forwarding: MeForwardingApi
go_override: GoOverrideApi
mode_management: MeModeManagementApi
personal_assistant: MePersonalAssistantApi
priority_alert: MePriorityAlertApi
recording: MeRecordingApi
schedules: MeSchedulesApi
selective_accept: MeSelectiveAcceptApi
selective_forward: MeSelectiveForwardApi
selective_reject: MeSelectiveRejectApi
sequential_ring: MeSequentialRingApi
sim_ring: MeSimRingApi
snr: MeSNRApi
voicemail: MeVoicemailApi
details() MeProfile[source]

Get My Own Details

Get profile details for the authenticated user.

Profile details include the user’s name, email, location and calling details.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

MeProfile

announcement_languages() list[AnnouncementLanguage][source]

Retrieve announcement languages for the authenticated user

Retrieve the list of available announcement languages for the authenticated user’s telephony configuration.

Announcement languages determine the language used for system prompts and announcements during calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

list[AnnouncementLanguage]

country_telephony_config_requirements(country_code: str) CountryTelephonyConfigRequirements[source]

Retrieve country-specific telephony configuration requirements

Retrieve country-specific telephony configuration requirements for the authenticated user.

Webex Calling supports multiple regions and time zones to validate and present the information using the local date and time, as well as localized dialing rules.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

country_code (str) – The ISO country code for which configuration requirements are requested.

Return type:

CountryTelephonyConfigRequirements

feature_access_codes() list[FeatureAccessCode][source]

Get My Feature Access Codes

Retrieve all Feature Access Codes configured for services that are assigned to the authenticated user. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.

Feature access codes (FACs), also known as star codes, give users access to advanced calling features.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

list[FeatureAccessCode]

monitoring_settings() MeMonitoringSettings[source]

Get My Monitoring Settings

Retrieves the monitoring settings of the logged in person, which shows specified people, places, virtual lines or call park extensions that are being monitored.

Monitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

MeMonitoringSettings

calling_services_list() list[ServicesEnum][source]

Get My Calling Services List

Retrieves the list of enabled calling services for the authenticated user.

These services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

list[ServicesEnum]

call_captions_settings() UserCallCaptions[source]

Get my call captions settings

Retrieve the effective call captions settings of the authenticated user.

NOTE: The call captions feature is not supported for Webex Calling Standard users or users assigned to 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 user auth token with a scope of spark:telephony_config_read.

Return type:

UserCallCaptions

available_numbers_for_location(name: str = None, phone_number: str = None, extension: str = None, order: str = None, **params: Any) Generator[LocationAssignedNumber, None, None][source]

Get Available Numbers for User’s Location.

Fetch all the numbers available in User’s location.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:
  • name (str) – List numbers whose owner name contains this string.

  • phone_number (str) – List numbers whose phoneNumber contains this string.

  • extension (str) – List numbers whose extension contains this string.

  • order (str) – Sort the list of numbers based on lastName, dn, extension either asc or desc.

Returns:

Generator yielding LocationAssignedNumber instances

guest_calling_numbers() list[GuestCallingNumber][source]

Retrieve My Guest Calling Numbers

Retrieve available guest calling numbers for the authenticated user.

This API returns a list of phone numbers that can be used for guest calling purposes.

Retrieving guest calling numbers requires a user auth token with a scope of spark:telephony_config_read.

Return type:

list[GuestCallingNumber]

contact_center_extensions() CCExtensions[source]

Read the Contact Center Extensions

Retrieves the Contact Center phone number, extension, virtual numbers, endpoints, and endpoints registration status associated with the authenticated user. This API returns all primary and secondary endpoints, the hot desk guest profiles currently hosted on the agent’s own devices, if any, and registration status of those endpoints. Only virtual line extensions hosted exclusively on the agent’s devices and the registration status of those virtual line endpoints will be retrieved. Any virtual lines shared with devices not owned by the current user will be excluded.

A Webex Calling Contact Center extension is a calling extension assigned to a user or device within the Webex Contact Center for internal dialing.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

CCExtensions

class wxc_sdk.me.MeProfile(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, email: str | None = None, announcementLanguage: str | None = None, locationDialingCode: str | None = None, supportMobility: bool | None = None, emergencyCallBackNumber: str | None = None, phoneNumbers: list[MeNumber] | None = None, devices: list[MeDevice] | None = None, location: LocationNameAddress | None = None, receptionistUrl: str | None = None, callingHostUrl: str | None = None, attendantConsoleUrl: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier of the user.

last_name: str | None

Last name of the user.

first_name: str | None

First name of the user.

email: str | None

The email addresses of the person.

announcement_language: str | None

Language for announcements.

location_dialing_code: str | None

Dialing code for the user’s location.

support_mobility: bool | None

If true, the user supports mobility.

emergency_call_back_number: str | None

Emergency callback number for the user.

phone_numbers: list[MeNumber] | None

List of numbers associated with the user.

devices: list[MeDevice] | None

List of devices associated with the user.

location: LocationNameAddress | None

Location details for the user.

receptionist_url: str | None

URL for the receptionist console.

calling_host_url: str | None

URL for the calling host.

attendant_console_url: str | None

URL for the attendant console.

class wxc_sdk.me.MeNumber(*, directNumber: str | None = None, enterprise: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, primary: bool | None = None, state: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

direct_number: str | None

Direct number of the user.

enterprise: str | None

Enterprise number of the user. This always combines the location routing prefix with the user’s extension, and is only present when both are present. That is, the location has a routing prefix and the user has an extension.

extension: str | None

Extension of the user. This is always the user’s extension, only present if the user has an extension.

routing_prefix: str | None

Routing prefix of the user.

esn: str | None

Enterprise Significant Number. This combines the location routing prefix and extension when both are set, and only the extension when the location routing prefix is not set. if the extension is not set, the esn is not present.

primary: bool | None

Indicates if the number is primary or alternate number.

state: str | None
class wxc_sdk.me.MeOwner(*, lastName: str | None = None, firstName: str | None = None, type: UserType | None = None, **extra_data: Any)[source]

Bases: ApiModel

last_name: str | None

First name of device owner.

first_name: str | None

Last name of device owner.

type: UserType | None

Enumeration that indicates if the member is of type PEOPLE or PLACE.

class wxc_sdk.me.MeDevice(*, description: list[str] | None = None, model: str | None = None, mac: str | None = None, primaryOwner: bool | None = None, type: PrimaryOrShared | None = None, owner: MeOwner | None = None, activationState: DeviceActivationState | None = None, **extra_data: Any)[source]

Bases: ApiModel

description: list[str] | None

Comma separated array of tags used to describe device.

model: str | None

Identifier for device model.

mac: str | None

MAC address of the device.

primary_owner: bool | None

Indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device.

type: PrimaryOrShared | None

Indicates if the line is acting as a primary line or a shared line for this device.

owner: MeOwner | None

Owner of device..

activation_state: DeviceActivationState | None

Activation state of the device.

class wxc_sdk.me.LocationNameAddress(*, name: str | None = None, address: LocationAddress | None = None, **extra_data: Any)[source]

Bases: ApiModel

name: str | None

Name of the location.

address: LocationAddress | None

Address details for the location.

class wxc_sdk.me.CountryTelephonyConfigRequirements(*, stateRequired: bool | None = None, zipCodeRequired: bool | None = None, states: list[AnnouncementLanguage] | None = None, timeZones: list[str] | None = None, **extra_data: Any)[source]

Bases: ApiModel

state_required: bool | None

If stateRequired should be a Mandatory field in UI

zip_code_required: bool | None

If zipCodeRequired should be a Mandatory field in UI

states: list[AnnouncementLanguage] | None
time_zones: list[str] | None

List of supported timezones for the country.

class wxc_sdk.me.FeatureAccessCode(*, name: str | None = None, code: str | None = None, alternateCode: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

name: str | None

Feature Access Code name.

code: str | None

Feature Access Code.

alternate_code: str | None

Alternate Code for the Feature Access Code.

class wxc_sdk.me.MeMonitoringSettings(*, callParkNotificationEnabled: bool | None = None, monitoredElements: list[MeMonitoredElement] | None = None, **extra_data: Any)[source]

Bases: ApiModel

call_park_notification_enabled: bool | None

Call park notification is enabled or disabled. Only applies to monitored users, workspaces, and virtual lines. Does not apply to call park extensions.

monitored_elements: list[MeMonitoredElement] | None

Settings of monitored elements which can be person, place, virtual line or call park extension.

class wxc_sdk.me.MeMonitoredElement(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, type: MonitoredElementType | None = None, email: str | None = None, directNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, locationName: str | None = None, locationId: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

The identifier of the monitored person.

last_name: str | None

The last name of the monitored person or virtual line.

first_name: str | None

The first name of the monitored person or virtual line.

display_name: str | None

The display name of the monitored place or call park extension.

type: MonitoredElementType | None

Indicates whether the type is PEOPLE, PLACE, VIRTUAL_LINE or CALL_PARK_EXTENSION.

email: str | None

The email address of the monitored person, place or virtual line.

direct_number: str | None

The list of phone numbers of the monitored person, place or virtual line.

extension: str | None

The extension number for the person, place, virtual line or call park extension.

routing_prefix: str | None

Routing prefix of location.

esn: str | None

Enterprise Significant Numbers (Routing prefix + extension of a person, place, virtual line).

location_name: str | None

The location name where the monitored item is.

location_id: str | None

The ID for the location.

class wxc_sdk.me.MonitoredElementType(*values)[source]

Bases: str, SafeEnum

An enumeration.

people = 'PEOPLE'

The monitored element is a user.

place = 'PLACE'

The monitored element is a workspace.

virtual_line = 'VIRTUAL_LINE'

The monitored element is a virtual line.

call_park_extension = 'CALL_PARK_EXTENSION'

The monitored element is a call park extension.

class wxc_sdk.me.ServicesEnum(*values)[source]

Bases: str, SafeEnum

An enumeration.

anonymous_call_rejection = 'Anonymous Call Rejection'

When enabled, blocks all incoming calls from unidentified or blocked caller IDs.

authentication = 'Authentication'

Requires the user to enter a password before making a call.

call_forwarding_always = 'Call Forwarding Always'

Forwards all incoming calls to another number.

call_forwarding_busy = 'Call Forwarding Busy'

Forwards incoming calls to another number when the user is on another call.

call_forwarding_no_answer = 'Call Forwarding No Answer'

Forwards incoming calls to another number when the user does not answer.

call_notify = 'Call Notify'

Notifies the user of incoming calls.

calling_line_id_delivery_blocking = 'Calling Line ID Delivery Blocking'

Blocks the delivery of the user’s caller ID to the recipient.

do_not_disturb = 'Do Not Disturb'

Blocks all incoming calls.

intercept_user = 'Intercept User'

Allows the user to intercept another user’s calls.

last_number_redial = 'Last Number Redial'

Redials the last number called.

priority_alert = 'Priority Alert'

Alerts the user of incoming calls with a distinctive ring.

call_return = 'Call Return'

Returns the last call received.

selective_call_acceptance = 'Selective Call Acceptance'

Accepts only calls from a list of pre-approved numbers.

call_forwarding_selective = 'Call Forwarding Selective'

Forwards calls from a list of pre-approved numbers.

selective_call_rejection = 'Selective Call Rejection'

Rejects calls from a list of pre-approved numbers.

simultaneous_ring_personal = 'Simultaneous Ring Personal'

Rings multiple numbers at the same time.

voice_messaging_user = 'Voice Messaging User'

Allows the user to access voicemail.

alternate_numbers = 'Alternate Numbers'

Allows the user to have multiple numbers.

shared_call_appearance_35 = 'Shared Call Appearance 35'

Allows the user to share a call appearance with another user.

speed_dial_100 = 'Speed Dial 100'

Allows the user to dial a number by pressing a single key.

directed_call_pickup = 'Directed Call Pickup'

Allows the user to pick up a call directed to another user.

directed_call_pickup_with_barge_in = 'Directed Call Pickup with Barge-in'

Allows the user to pick up a call directed to another user and join the call.

external_calling_line_id_delivery = 'External Calling Line ID Delivery'

Displays the caller’s ID on the user’s phone.

internal_calling_line_id_delivery = 'Internal Calling Line ID Delivery'

Displays the caller’s ID on the user’s phone.

call_waiting = 'Call Waiting'

Alerts the user of incoming calls when they are on another call.

barge_in_exempt = 'Barge-in Exempt'

Prevents other users from barging in on the user’s calls.

push_to_talk = 'Push to Talk'

Allows the user to push a button to talk.

basic_call_logs = 'Basic Call Logs'

Logs the user’s call history.

hoteling_host = 'Hoteling Host'

Allows the user to host a hoteling session.

hoteling_guest = 'Hoteling Guest'

Allows the user to join a hoteling session.

multiple_call_arrangement = 'Multiple Call Arrangement'

Allows the user to have multiple calls at the same time.

busy_lamp_field = 'Busy Lamp Field'

Allows the user to monitor the status of another user’s phone.

three_way_call = 'Three-Way Call'

Allows the user to have a three-way call.

call_transfer = 'Call Transfer'

Allows the user to transfer a call.

privacy = 'Privacy'

Allows the user to keep their number private.

fax_messaging = 'Fax Messaging'

Allows the user to send and receive faxes.

n_way_call = 'N-Way Call'

Allows the user to have an N-way call.

call_forwarding_not_reachable = 'Call Forwarding Not Reachable'

Forwards calls when the user is not reachable.

connected_line_identification_presentation = 'Connected Line Identification Presentation'

Displays the caller’s ID on the user’s phone.

connected_line_identification_restriction = 'Connected Line Identification Restriction'

Prevents the caller’s ID from being displayed on the user’s phone.

broad_works_anywhere = 'BroadWorks Anywhere'

Allows the user to make calls from any phone.

music_on_hold_user = 'Music On Hold User'

Allows the user to listen to music while on hold.

call_center_monitoring = 'Call Center Monitoring'

Allows the user to monitor a call center.

broad_works_mobility = 'BroadWorks Mobility'

Allows the user to use BroadWorks Mobility.

call_recording = 'Call Recording'

Allows the user to record calls.

executive = 'Executive'

Allows the user to have an executive assistant.

client_license_17 = 'Client License 17'

Allows the user to use client license 17.

client_license_18 = 'Client License 18'

Allows the user to use client license 18.

flexible_seating_guest = 'Flexible Seating Guest'

Allows the user to be a flexible seating guest.

personal_assistant = 'Personal Assistant'

Allows the user to have a personal assistant.

sequential_ring = 'Sequential Ring'

Allows the user to have a sequential ring.

call_block = 'Call Block'

Allows the user to block calls.

call_center_premium = 'Call Center - Premium'
calling_name_retrieval = 'Calling Name Retrieval'
executive_assistant = 'Executive-Assistant'
class wxc_sdk.me.LocationAssignedNumber(*, phoneNumber: str | None = None, extension: str | None = None, state: NumberState | None = None, phoneNumberType: NumberListPhoneNumberType | None = None, tollFreeNumber: bool | None = None, owner: NumberOwner | None = None, **extra_data: Any)[source]

Bases: ApiModel

phone_number: str | None

The phone number in E.164 format.

extension: str | None

The extension.

state: NumberState | None
  • ACTIVE - Phone number is in the active state.

phone_number_type: NumberListPhoneNumberType | None
  • PRIMARY - A direct phone number.

  • ALTERNATE - An alternate phone number.

  • FAX - A FAX number.

toll_free_number: bool | None

Indicate if the number is toll free.

owner: NumberOwner | None

The owner details.

class wxc_sdk.me.GuestCallingNumber(*, phoneNumber: str | None = None, state: NumberState | None = None, isMainNumber: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

phone_number: str | None

Phone number available for guest calling.

state: NumberState | None
is_main_number: bool | None

Indicates whether this is the location’s main number.

class wxc_sdk.me.UserEndpointType(*, id: str | None = None, type: EndpointType | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier of the endpoint.

type: EndpointType | None

Type of the endpoint.

class wxc_sdk.me.UserExtension(*, directNumber: str | None = None, extension: str | None = None, type: PrimaryOrSecondary | None = None, lineOwnerType: UserType | None = None, lineOwnerId: str | None = None, preferredAnsweringEndPointId: str | None = None, endpoints: list[UserEndpointType] | None = None, **extra_data: Any)[source]

Bases: ApiModel

direct_number: str | None

Direct number of the user.

extension: str | None

Extension of the user.

type: PrimaryOrSecondary | None

Type of User Extension.

line_owner_type: UserType | None

Type of the line owner. Indicates whether the line is owned by a person, workspace, or virtual line.

line_owner_id: str | None

Unique identifier of the line owner.

preferred_answering_end_point_id: str | None

Unique identifier of the set preferred answering endpoint.

endpoints: list[UserEndpointType] | None

List of user endpoints with type.

class wxc_sdk.me.EndpointStatus(*values)[source]

Bases: str, SafeEnum

An enumeration.

connected = 'CONNECTED'

Device is connected.

not_connected = 'NOT_CONNECTED'

Device is not connected.

class wxc_sdk.me.UserEndpoint(*, id: str | None = None, type: EndpointType | None = None, name: str | None = None, status: EndpointStatus | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier of the endpoint.

type: EndpointType | None

Type of the endpoint.

name: str | None

Name of the endpoint.

status: EndpointStatus | None

SIP Registration status of the device.

class wxc_sdk.me.CCExtensions(*, ccExtensions: list[UserExtension] | None = None, endpoints: list[UserEndpoint] | None = None, **extra_data: Any)[source]

Bases: ApiModel

cc_extensions: list[UserExtension] | None

List of user extensions.

endpoints: list[UserEndpoint] | None

List of user endpoints details.

Subpackages