wxc_sdk.person_settings.permissions_in module

Person incoming permissions API

class wxc_sdk.person_settings.permissions_in.ExternalTransfer(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

Specifies the transfer behavior for incoming, external calls.

allow_all_external = 'ALLOW_ALL_EXTERNAL': Allow transfer and forward for all external calls including those which were transferred.

allow_only_transferred_external = 'ALLOW_ONLY_TRANSFERRED_EXTERNAL': Only allow transferred calls to be transferred or forwarded and disallow transfer of other external calls.

block_all_external = 'BLOCK_ALL_EXTERNAL': Block all external calls from being transferred or forwarded.

class wxc_sdk.person_settings.permissions_in.IncomingPermissions(*, useCustomEnabled: bool, externalTransfer: ExternalTransfer, internalCallsEnabled: bool, collectCallsEnabled: bool)[source]

Bases: ApiModel

Person’s Incoming Permission Settings

use_custom_enabled: bool: When true, indicates that this person uses the specified calling permissions for receiving inbound calls rather than the organizational defaults.

external_transfer: ExternalTransfer: Specifies the transfer behavior for incoming, external calls.

internal_calls_enabled: bool: Internal calls are allowed to be received.

collect_calls_enabled: bool: Collect calls are allowed to be received.

static allow_all() → IncomingPermissions[source]

allow everything

Returns:: IncomingPermissions

static default() → IncomingPermissions[source]

default settings

Returns:: IncomingPermissions

class wxc_sdk.person_settings.permissions_in.IncomingPermissionsApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for incoming permissions settings

Also used for virtual lines, workspaces

feature = 'incomingPermission'

read(entity_id: str, org_id: str | None = None) → IncomingPermissions[source]

Read Incoming Permission Settings

Retrieve Incoming Permission Settings

You can change the incoming calling permissions for an entity if you want them to be different from your organization’s default.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

Parameters:

entity_id (str) – Unique identifier for the entity.
org_id (str) – entity is in this organization. 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.

Returns:

incoming permission settings for specific user

Return type:

IncomingPermissions

configure(entity_id: str, settings: IncomingPermissions, org_id: str | None = None)[source]

Configure incoming permissions settings

The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.

This API requires a full or user administrator auth token with the spark-admin:people_write scope or a user auth token with spark:people_write scope can be used by an entity to update their own settings.

Parameters:

entity_id (str) – Unique identifier for the entity.
settings (IncomingPermissions) – new setting to be applied
org_id (str) – entity is in this organization. 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.

base = ''