wxc_sdk.person_settings.ecbn module

class wxc_sdk.person_settings.ecbn.ECBNApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: PersonSettingsApiChild

Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.

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

feature = 'emergencyCallbackNumber'

read(entity_id: str, org_id: str | None = None) → PersonECBN

Get an entity’s Emergency Callback Number

Retrieve an entity’s emergency callback number settings. Also applies to workspaces and virtual lines.

Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emergency Service Addresses to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.

To retrieve an entity’s callback number requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

• entity_id (str) – Unique identifier for the entity, virtual line, or workspace

• org_id (str) – ID of the organization within which the entity resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Return type:

PersonECBN

configure(entity_id: str, selected: SelectedECBN, location_member_id: str | None = None, org_id: str | None = None)

Update an entity’s Emergency Callback Number.

Update an entity’s emergency callback number settings. Also applies to workspaces and virtual lines.

Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.

To update an emergency callback number requires a full, location, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• entity_id (str) – Unique identifier for the entity, virtual line, or workspace.

• selected (SelectedECBN) – The source from which the emergency calling line ID (CLID) is selected for an actual emergency call.

• location_member_id (str) – Member ID of person/workspace/virtual line within the location.

• org_id (str) – ID of the organization within which the entity resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Return type:

None

dependencies(entity_id: str, org_id: str | None = None) → ECBNDependencies

Retrieve an entity’s Emergency Callback Number Dependencies

Retrieve Emergency Callback Number dependencies for an entity. Also applies to workspaces and virtual lines.

Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.

Retrieving the dependencies requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

• entity_id (str) – Unique identifier for the person, virtual line, or workspace

• org_id (str) – Retrieve Emergency Callback Number attributes for this organization.

Return type:

ECBNDependencies

base = ''

class wxc_sdk.person_settings.ecbn.ECBNQuality(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

recommended = 'RECOMMENDED'

Active number assigned to a user or workspace or virtual line.

not_recommended = 'NOT_RECOMMENDED'

Active number assigned to something that may not be an attended destination.

invalid = 'INVALID'

A number for which callbacks will not work, for instance, one without a valid caller ID.

class wxc_sdk.person_settings.ecbn.ECBNDependencies(*, isLocationEcbnDefault: bool | None = None, isSelfEcbnDefault: bool | None = None, dependentMemberCount: int | None = None, **extra_data: Any)

Bases: ApiModel

is_location_ecbn_default: bool | None

The default emergency callback number for the location when isLocationEcbnDefault is true.

is_self_ecbn_default: bool | None

The default emergency callback number for the person when isSelfEcbnDefault is true.

dependent_member_count: int | None

Number of members using this person as their emergency callback number.

class wxc_sdk.person_settings.ecbn.PersonECBN(*, selected: ECBNSelection | None = None, directLineInfo: PersonECBNDirectLine | None = None, locationECBNInfo: PersonECBNDirectLine | None = None, locationMemberInfo: ECBNLocationMember | None = None, defaultInfo: ECBNDefault | None = None, **extra_data: Any)

Bases: ApiModel

selected: ECBNSelection | None

Selected number type to configure emergency callback.

direct_line_info: PersonECBNDirectLine | None

Data relevant to the ECBN for this user/location/virtual line.

location_ecbn_info: PersonECBNDirectLine | None

Data relevant to the ECBN for this user/location/virtual line.

location_member_info: ECBNLocationMember | None

Data relevant to the ECBN for this user/location/virtual line.

default_info: ECBNDefault | None

Gives Emergency Callback Number effective value when none of the above is assigned or some other value is set behind the scene.

class wxc_sdk.person_settings.ecbn.ECBNDefault(*, effectiveValue: str | None = None, quality: ECBNQuality | None = None, **extra_data: Any)

Bases: ApiModel

effective_value: str | None

The field contains the ECBN number.

quality: ECBNQuality | None

Used to represent whether a number is a recommended ECBN.

class wxc_sdk.person_settings.ecbn.PersonECBNDirectLine(*, phoneNumber: str | None = None, firstName: str | None = None, lastName: str | None = None, effectiveLevel: ECBNEffectiveLevel | None = None, effectiveValue: str | None = None, quality: ECBNQuality | None = None, **extra_data: Any)

Bases: ApiModel

phone_number: str | None

The callback phone number that is associated with the direct line.

first_name: str | None

First name of the user.

last_name: str | None

Last name of the user.

effective_level: ECBNEffectiveLevel | None

The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.

effective_value: str | None

The field contains the valid ECBN number at the location level, or the user’s main number if valid, defaulting to the location’s main number if both are unavailable.

quality: ECBNQuality | None

Used to represent whether a number is a recommended ECBN.

class wxc_sdk.person_settings.ecbn.ECBNLocationMember(*, phoneNumber: str | None = None, firstName: str | None = None, lastName: str | None = None, memberId: str | None = None, memberType: UserType | None = None, effectiveLevel: ECBNLocationEffectiveLevel | None = None, effectiveValue: str | None = None, quality: ECBNQuality | None = None, **extra_data: Any)

Bases: ApiModel

phone_number: str | None

The callback phone number that is associated with member configured for the location ECBN.

first_name: str | None

First name of the user.

last_name: str | None

Last name of the user or ..

member_id: str | None

Member ID of user/place/virtual line within the location

member_type: UserType | None

Indicates the type of the member.

effective_level: ECBNLocationEffectiveLevel | None

The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary.

effective_value: str | None

The field contains the valid ECBN number at the location level, or the user’s main number if valid, defaulting to the location’s main number if both are unavailable.

quality: ECBNQuality | None

Used to represent whether a number is a recommended ECBN.

class wxc_sdk.person_settings.ecbn.ECBNEffectiveLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

direct_line = 'DIRECT_LINE'

Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member’s phone is specific to the member’s location.

location_ecbn = 'LOCATION_ECBN'

Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.

location_number = 'LOCATION_NUMBER'

A location’s main number that is suitable for when the location has a single building with a single floor.

location_member_number = 'LOCATION_MEMBER_NUMBER'

Assigned number of a user or workspace in the location.

none_ = 'NONE'

When no other option is selected.

class wxc_sdk.person_settings.ecbn.ECBNSelection(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

direct_line = 'DIRECT_LINE'

Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member’s phone is specific to the member’s location.

location_ecbn = 'LOCATION_ECBN'

Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.

location_member_number = 'LOCATION_MEMBER_NUMBER'

This lets you configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.

none_ = 'NONE'

When no other option is selected.

class wxc_sdk.person_settings.ecbn.SelectedECBN(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

direct_line = 'DIRECT_LINE'

Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member’s phone is specific to the member’s location.

location_ecbn = 'LOCATION_ECBN'

Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.

location_member_number = 'LOCATION_MEMBER_NUMBER'

This lets you configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.

class wxc_sdk.person_settings.ecbn.ECBNLocationEffectiveLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

direct_line = 'DIRECT_LINE'

Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member’s phone is specific to the member’s location.

location_ecbn = 'LOCATION_ECBN'

Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.

location_number = 'LOCATION_NUMBER'

A location’s main number that is suitable for when the location has a single building with a single floor.

location_member_number = 'LOCATION_MEMBER_NUMBER'

This lets you configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.

none_ = 'NONE'

When no other option is selected.