wxc_sdk.person_settings.call_policy module

class wxc_sdk.person_settings.call_policy.CallPolicyApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for call policy settings.

For now only used for workspaces

feature: str | None = 'callPolicies'
read(entity_id: str, org_id: str = None) → PrivacyOnRedirectedCalls[source]

Read Call Policy Settings for an entity

Retrieve Call Policies settings.

The call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.

This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:workspaces_read scope can be used to read workspace settings.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • org_id (str) – ID of the organization in 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:

PrivacyOnRedirectedCalls

configure(entity_id: str, connected_line_id_privacy_on_redirected_calls: PrivacyOnRedirectedCalls, org_id: str = None)[source]

Configure Call Policy Settings for an entity

Configure Call Policies settings.

The call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.

This API requires a full or user administrator or location administrator auth token with the spark-admin:workspaces_write scope can be used to update workspace settings.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • connected_line_id_privacy_on_redirected_calls (PrivacyOnRedirectedCalls) – Specifies the connection type to be used.

  • org_id (str) – ID of the organization in 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

base = ''
class wxc_sdk.person_settings.call_policy.PrivacyOnRedirectedCalls(*values)[source]

Bases: str, SafeEnum

An enumeration.

no_privacy = 'NO_PRIVACY'

Connected line identification is not blocked on redirected calls.

privacy_for_external_calls = 'PRIVACY_FOR_EXTERNAL_CALLS'

Connected line identification is blocked on redirected calls to external numbers.

privacy_for_all_calls = 'PRIVACY_FOR_ALL_CALLS'

Connected line identification is blocked on all redirected calls.