wxc_sdk.telephony.caller_reputation package

class wxc_sdk.telephony.caller_reputation.CallerReputationProviderProvider(*, id: str | None = None, enabled: bool | None = None, name: str | None = None, regions: list[ReputationProviderRegion] | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the provider.

enabled: bool | None

Indicates if the provider is enabled.

name: str | None

Name of the provider.

regions: list[ReputationProviderRegion] | None

List of regions for the provider.

class wxc_sdk.telephony.caller_reputation.ReputationProviderRegion(*, id: str | None = None, name: str | None = None, type: str | None = None, visible: bool | None = None, environmentType: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the region.

name: str | None

Name of the region.

type: str | None

Type of the region (e.g., primary, secondary).

visible: bool | None

Indicates if the region is visible.

environment_type: str | None

Environment type of the region (e.g., production, staging).

class wxc_sdk.telephony.caller_reputation.ReputationProviderSettings(*, name: str | None = None, id: str | None = None, clientId: str | None = None, clientSecret: str | None = None, enabled: bool | None = None, callBlockScoreThreshold: str | None = None, callAllowScoreThreshold: str | None = None, **extra_data: Any)

Bases: ApiModel

name: str | None

Name of the reputation provider.

id: str | None

Unique identifier for the reputation provider.

client_id: str | None

Client ID used for integration with the reputation provider.

client_secret: str | None

Client secret. Cannot be read, only available for update()

enabled: bool | None

Indicates if the caller reputation provider service is enabled.

call_block_score_threshold: str | None

Score threshold for blocking calls.

call_allow_score_threshold: str | None

Score threshold for allowing calls.

class wxc_sdk.telephony.caller_reputation.ReputationProviderStatus(*, id: str | None = None, status: ReputationProviderState | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the reputation provider.

status: ReputationProviderState | None

class wxc_sdk.telephony.caller_reputation.ReputationProviderState(*values)

Bases: str, SafeEnum

An enumeration.

not_connected = 'NOT_CONNECTED'

Provider is not connected.

connecting = 'CONNECTING'

Provider is in the process of connecting.

connected = 'CONNECTED'

Provider is connected.

active = 'ACTIVE'

Provider is active and operational.

expired = 'EXPIRED'

Provider’s session or token has expired.

auth_failed = 'AUTH_FAILED'

Authentication with the provider failed.

provider_disabled = 'PROVIDER_DISABLED'

Provider is disabled.

class wxc_sdk.telephony.caller_reputation.CallerReputationProviderApi(*, session: RestSession, base: str = None)

Bases: ApiChild

Webex Calling Integration with calling reputation provider

Webex Calling integrates with telephony Calling Reputation Providers to enhance call security and reduce unwanted or fraudulent calls.

Webex Calling offers a comprehensive, secure, and reliable cloud PBX solution with several features that support call quality and security.

get(organization_id: str = None) → ReputationProviderSettings

Get Caller Reputation Provider Service Settings

Retrieves the configuration and status of the caller reputation provider service for Webex Calling.

Parameters:

organization_id (str) – Unique identifier for the organization.

Return type:

ReputationProviderSettings

update(settings: ReputationProviderSettings, organization_id: str = None)

Update Caller Reputation Provider Service Settings

Updates the configuration of the caller reputation provider service for Webex Calling.

Parameters:

• settings (ReputationProviderSettings) – New settings for caller reputation provider service

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

Return type:

None

unlock(rep_id: str, organization_id: str = None)

Unlock Caller Reputation Provider

Unlocks the caller reputation provider for Webex Calling.

Parameters:

• rep_id (str) – Unique identifier for the reputation provider.

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

Return type:

None

providers(organization_id: str = None) → list[CallerReputationProviderProvider]

Get Caller Reputation Provider Providers

Retrieves the list of available caller reputation providers and their regions for Webex Calling.

Parameters:

organization_id (str) – Unique identifier for the organization.

Return type:

list[CallerReputationProviderProvider]

status(organization_id: str = None) → ReputationProviderStatus

Get Caller Reputation Provider Status

Retrieves the current status of the caller reputation provider integration for Webex Calling.

Parameters:

organization_id (str) – Unique identifier for the organization.

Return type:

ReputationProviderStatus

base = 'telephony/config/serviceSettings/callerReputationProvider'