wxc_sdk.me.snr package

class wxc_sdk.me.snr.MeSNRApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

settings() → MeSNRSettings

Get User’s Single Number Reach Settings

Retrieves all single number reach settings configured for the authenticated user.

The “Single Number Reach” feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.

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

Return type:

MeSNRSettings

update(alert_all_locations_for_click_to_dial_calls_enabled: bool | None = None)

Update User’s Single Number Reach Settings

Updates single number reach settings associated with the authenticated user.

The “Single Number Reach” feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.

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

Parameters:

alert_all_locations_for_click_to_dial_calls_enabled (bool) – If true, all locations will be alerted for click-to-dial calls.

Return type:

None

create_snr(settings: SingleNumberReachNumber) → str

Add phone number as User’s Single Number Reach

Add a phone number as a single number reach for the authenticated user.

The “Single Number Reach” feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.

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

Parameters:

settings (SingleNumberReachNumber) – User’s Single Number Reach Settings

Returns:

Unique identifier of the phone number.

Return type:

str

delete_snr(phone_number_id: str)

Delete User’s Single Number Reach Contact Settings

Delete contact settings associated with the authenticated user.

The “Single Number Reach” feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.

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

Parameters:

phone_number_id (str) – Unique identifier of the phone number.

Return type:

None

update_snr(phone_number_id: str, settings: SingleNumberReachNumber)

Modify User’s Single Number Reach Contact Settings

Update the contact settings of single number reach for the authenticated user.

The “Single Number Reach” feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.

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

Parameters:

• phone_number_id (str) – Unique identifier of the phone number.

• settings (SingleNumberReachNumber) – User’s Single Number Reach Settings

base = 'telephony/config/people/me'

class wxc_sdk.me.snr.MeSNRSettings(*, enabled: bool | None = None, alertAllLocationsForClickToDialCallsEnabled: bool | None = None, alertAllLocationsForGroupPagingCallsEnabled: bool | None = None, numbers: list[SingleNumberReachNumber] | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

If true, the Single Number Reach feature is enabled.

alert_all_locations_for_click_to_dial_calls_enabled: bool | None

If true, all locations will be alerted for click-to-dial calls.

alert_all_locations_for_group_paging_calls_enabled: bool | None

If true, all locations will be alerted for group paging calls.

numbers: list[SingleNumberReachNumber] | None

List of numbers configured for Single Number Reach.