wxc_sdk.person_settings.anon_calls module

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

Bases: PersonSettingsApiChild

API for anonymous call reject settings; so far only used for workspaces

feature = 'anonymousCallReject'
read(entity_id: str, org_id: str = None) → bool[source]

Retrieve Anonymous Call Settings for an entity.

Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.

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 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:

bool

configure(entity_id: str, enabled: bool, org_id: str = None)[source]

Modify Anonymous Call Settings for an entity.

Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.

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

Parameters:

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

  • enabled (bool) – true if the Anonymous Call Rejection feature is enabled.

  • 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

base = ''