wxc_sdk.person_settings.answer package

class wxc_sdk.person_settings.answer.AnswerApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: ApiChild

API for Answer Settings. Used for person, workspace, and virtual line answer settings.

__init__(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

read(entity_id: str, org_id: str = None) → AnswerSettings

Get Answer Settings for an Entity

Get the answer settings for a specific person.

Answer settings allow administrators to configure automatic call answering behavior for an entity, including preferred answer endpoint and whether auto answer is enabled.

This API requires a full administrator, read-only administrator, delegated full administrator, user administrator, or location administrator auth token with the spark-admin:telephony_config_read scope.

Parameters:

• entity_id (str) – The unique identifier for the person.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

AnswerSettings

update(entity_id: str, preferred_answer_endpoint_id: str = None, auto_answer_enabled: bool = None, is_preferred_endpoint_clearable_by_person: bool = None, org_id: str = None) → None

Update Answer Settings for an Entity

Modify the answer settings for a specific person.

Answer settings allow administrators to configure automatic call answering behavior for an entity, including preferred answer endpoint and whether auto answer is enabled. To clear the preferred answer endpoint, the preferredAnswerEndpointId must be set to null.

This API requires a full administrator, delegated full administrator, user administrator, or location administrator auth token with the spark-admin:telephony_config_write scope.

Parameters:

• entity_id (str) – The unique identifier for the person.

• preferred_answer_endpoint_id (str) – The unique identifier for the preferred answer endpoint. This may be a device, application, or hot desking guest endpoint. Set to null to clear the preferred answer endpoint; omit to leave unchanged.

• auto_answer_enabled (bool) – Indicates whether auto answer is enabled for the person.

• is_preferred_endpoint_clearable_by_person (bool) – Indicates whether the person can clear the preferred endpoint setting.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

available_preferred_answer_endpoints(entity_id: str, org_id: str = None) → list[AnswerEndpoint]

Get Available Preferred Answer Endpoints for an Entity

Get the list of available preferred answer endpoints for a specific person. This API returns all available endpoints in a single response.

A Webex Calling person may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices, or third-party endpoints. Preferred answering endpoints allow administrators to specify which of these devices should be prioritized for answering calls, particularly when an entity’s extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.

This API requires a full administrator, read-only administrator, delegated full administrator, user administrator, or location administrator auth token with the spark-admin:telephony_config_read scope.

Parameters:

• entity_id (str) – The unique identifier for the person.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

list[AnswerEndpoint]

base = ''

class wxc_sdk.person_settings.answer.AnswerSettings(*, preferredAnswerEndpointId: str | None = None, preferredAnswerEndpointType: AnswerSettingsEndpointType | None = None, preferredAnswerEndpointIdType: EndpointType | None = None, preferredAnswerEndpointRequired: bool | None = None, autoAnswerEnabled: bool | None = None, isPreferredEndpointClearableByPerson: bool | None = None, **extra_data: Any)

Bases: ApiModel

preferred_answer_endpoint_id: str | None

The unique identifier for the preferred answer endpoint. The companion preferredAnswerEndpointIdType identifies the encoded resource type as APPLICATION, CALLING_DEVICE, or HOTDESKING_GUEST.

preferred_answer_endpoint_type: AnswerSettingsEndpointType | None

The preferred endpoint’s behavior category.

preferred_answer_endpoint_id_type: EndpointType | None

The resource type encoded by preferredAnswerEndpointId.

preferred_answer_endpoint_required: bool | None

Indicates whether the person must have a preferred answer endpoint selected in order for a call to be auto-answered.

auto_answer_enabled: bool | None

Indicates whether auto answer is enabled for the person.

is_preferred_endpoint_clearable_by_person: bool | None

Indicates whether the person can clear the preferred endpoint setting.

class wxc_sdk.person_settings.answer.AnswerEndpoint(*, id: str | None = None, type: EndpointType | None = None, name: str | None = None, isPreferredAnswerEndpoint: bool | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the endpoint. The companion type identifies the endpoint category; the opaque identifier represents a CALLING_DEVICE, APPLICATION, or HOTDESKING_GUEST resource.

type: EndpointType | None

name: str | None

Name of the endpoint. For a device endpoint, the name can include the value of a configured name=<value> device tag.

is_preferred_answer_endpoint: bool | None

Indicates whether this endpoint is currently selected as the preferred answer endpoint.

class wxc_sdk.person_settings.answer.AnswerSettingsEndpointType(*values)

Bases: str, SafeEnum

An enumeration.

webex_app_desktop = 'WEBEX_APP_DESKTOP'

The Webex desktop application answers the call.

primary_device = 'PRIMARY_DEVICE'

The person’s primary physical device answers the call.

non_primary_device = 'NON_PRIMARY_DEVICE'

A physical device other than the person’s primary device answers the call.

hotdesk_device = 'HOTDESK_DEVICE'

The device on which the person is signed in as a hot desking guest answers the call.

none_ = 'NONE'

No preferred answer endpoint is selected.