wxc_sdk.person_settings.single_number_reach package

class wxc_sdk.person_settings.single_number_reach.SingleNumberReachApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Features: Single Number Reach

Features: Single Number Reach APIs support reading and writing of Webex Calling Single Number Reach settings for a specific organization.

Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

A partner administrator can retrieve or change settings in a customer’s organization using the optional orgId query parameter.

available_phone_numbers(location_id: str, phone_number: list[str] | None = None, org_id: str | None = None, **params) → Generator[AvailableNumber, None, None][source]

Get Single Number Reach Primary Available Phone Numbers

List the service and standard PSTN numbers that are available to be assigned as the single number reach’s primary 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.

Parameters:

  • location_id (str) – Return the list of phone numbers for this location within the given organization. The maximum length is 36.

  • phone_number (list[str]) – Filter phone numbers based on the comma-separated list provided in the phoneNumber array.

  • org_id (str) – List numbers for this organization.

Returns:

Generator yielding SingleNumberReachPrimaryAvailableNumberObject instances

read(person_id: str) → SingleNumberReach[source]

Get Single Number Reach Settings For A Person

Retrieve Single Number Reach settings for the given person.

Single number reach allows you to set up your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don’t miss important calls.

Retrieving Single number reach settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

person_id (str) – Unique identifier for the person.

Return type:

SingleNumberReach

update(person_id: str, alert_all_numbers_for_click_to_dial_calls_enabled: bool | None = None)[source]

Update Single number reach settings for a person.

Single number reach allows you to set up your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don’t miss important calls.

Updating a single number reach settings for a person requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • alert_all_numbers_for_click_to_dial_calls_enabled (bool) – Flag to enable alerting single number reach numbers for click to dial calls.

Return type:

None

create_snr(person_id: str, settings: SingleNumberReachNumber) → str[source]

Create Single Number Reach For a Person

Create a single number reach for a person in an organization.

Single number reach allows you to set up your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don’t miss important calls.

Creating a single number reach for a person requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • settings (SingleNumberReachNumber) – Settings for new SNR number

Return type:

str

delete_snr(person_id: str, id: str, org_id: str | None = None)[source]

Delete A Single Number Reach Number

Delete Single number reach number for a person.

Single number reach allows you to setu p your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don’t miss important calls.

Deleting a Single number reach number requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • id (str) – Unique identifier for single number reach.

  • org_id (str) – Unique identifier for the organization.

Return type:

None

update_snr(person_id: str, settings: SingleNumberReachNumber) → str[source]

Update Single number reach settings for a number.

Single number reach allows you to set up your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don’t miss important calls.

The response returns an ID that can change if the phoneNumber is modified, as the ID contains base64 encoded phone number data.

Updating a single number reach settings for a number requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • settings (SingleNumberReachNumber) – Settings for new SNR number

Return type:

str

base = 'telephony/config'
class wxc_sdk.person_settings.single_number_reach.SingleNumberReach(*, enabled: bool | None = None, alertAllNumbersForClickToDialCallsEnabled: bool | None = None, numbers: list[SingleNumberReachNumber] | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

A flag to enable or disable single Number Reach.

alert_all_numbers_for_click_to_dial_calls_enabled: bool | None

Flag to enable alerting single number reach numbers for click to dial calls.

numbers: list[SingleNumberReachNumber] | None

Array of single number reach number entries.

class wxc_sdk.person_settings.single_number_reach.SingleNumberReachNumber(*, id: str | None = None, phoneNumber: str | None = None, enabled: bool | None = None, name: str | None = None, doNotForwardCallsEnabled: bool | None = None, answerConfirmationEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

ID of Single number reach. Note that this ID contains base64 encoded phoneNumber data and can change if the phone number is modified.

phone_number: str | None

The phone number that will ring when a call is received. The number should be in E.164 format.

enabled: bool | None

A flag to enable or disable this single Number Reach phone number.

name: str | None

Name of the single number reach phone number entry.

do_not_forward_calls_enabled: bool | None

If enabled, the call forwarding settings of provided phone Number will not be applied.

answer_confirmation_enabled: bool | None

If enabled, the call recipient will be prompted to press a key before being connected.