wxc_sdk.me.endpoints package

API for /me/endpoints

class wxc_sdk.me.endpoints.MeEndpointsApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

list() → list[MeEndpoint]

Read the List of My Endpoints

Retrieve the list of endpoints associated with the authenticated user.

Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

list[MeEndpoint]

details(endpoint_id: str) → MeEndpoint

Get My Endpoints Details

Get details of an endpoint associated with the authenticated user.

Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

endpoint_id (str) – Unique identifier of the endpoint.

Return type:

MeEndpoint

update(endpoint_id: str, mobility_alerting_enabled: bool)

Update My Endpoints Details

Update alerting settings of the mobility endpoint associated with the authenticated user.

Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

• endpoint_id (str) – Unique identifier of the endpoint.

• mobility_alerting_enabled (bool) – If true, alerting is enabled for the endpoint.

Return type:

None

available_preferred_answer_endpoints(org_id: str | None = None) → List[MeEndpoint]

Get List Available Preferred Answer Endpoints

Get the person’s preferred answer endpoint and the list of endpoints available for selection. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality.

A Webex Calling user 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 users to specify which of these devices should be prioritized for answering calls, particularly when a person’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 user auth token with a scope of spark:telephony_config_read.

Parameters:

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

list[Endpoints]

get_preferred_answer_endpoint() → MeEndpoint

Get Preferred Answer Endpoint

Retrieve the selected preferred answering endpoint for the user. If a preferred endpoint is not set for the person, API returns empty

A Webex Calling user 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 users to specify which of these devices should be prioritized for answering calls, particularly when a person’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 user auth token with a scope of spark:telephony_config_read.

Return type:

MeEndpoint

modify_preferred_answer_endpoint(id: str)

Modify Preferred Answer Endpoint

Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the id attribute must be set to null.

A Webex Calling user 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 users to specify which of these devices should be prioritized for answering calls, particularly when a person’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 user auth token with a scope of spark:telephony_config_write.

Parameters:

id (str) – Person’s preferred answer endpoint.

Return type:

None

base = 'telephony/config/people/me'

class wxc_sdk.me.endpoints.MeEndpoint(*, id: str | None = None, type: EndpointType | None = None, name: str | None = None, autoAndForcedAnswerEnabled: bool | None = None, ownerId: str | None = None, ownerType: UserType | None = None, secondaryLines: list[MeSecondaryLine] | None = None, mobilitySettings: MeMobility | None = None, host: MeHost | None = None, isPreferredAnswerEndpoint: bool | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the endpoint.

type: EndpointType | None

Type of the endpoint.

name: str | None

Display name of the endpoint.

auto_and_forced_answer_enabled: bool | None

If true, the endpoint can be remotely controlled, allowing actions such as mute, hold, resume and answer.

owner_id: str | None

Unique identifier of the endpoint owner.

owner_type: UserType | None

Type of the endpoint owner.

secondary_lines: list[MeSecondaryLine] | None

List of secondary lines. The secondary line information is not returned for the endpoint owned by an entity other than the authenticated user.

mobility_settings: MeMobility | None

Mobility settings of the endpoint.

host: MeHost | None

HOTDESKING_GUEST endpoints include the host element when the user has an active hotdesking session on a host.

is_preferred_answer_endpoint: bool | None

Indicates if this endpoint has been set as the preferred answer endpoint.

class wxc_sdk.me.endpoints.MeSecondaryLine(*, id: str | None = None, memberType: UserType | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the member.

member_type: UserType | None

Type of the member.

class wxc_sdk.me.endpoints.MeMobility(*, phoneNumber: str | None = None, alertingEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

phone_number: str | None

Phone number of the mobile device endpoint.

alerting_enabled: bool | None

If true, alerting is enabled for the endpoint.

class wxc_sdk.me.endpoints.EndpointType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

calling_device = 'CALLING_DEVICE'

Endpoint is a calling device.

application = 'APPLICATION'

Endpoint is an application.

hotdesking_guest = 'HOTDESKING_GUEST'

Endpoint is a hotdesking guest.

class wxc_sdk.me.endpoints.MeHost(*, id: str | None = None, type: EndpointType | None = None, name: str | None = None, autoAndForcedAnswerEnabled: bool | None = None, ownerId: str | None = None, ownerType: UserType | None = None, secondaryLines: list[MeSecondaryLine] | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the endpoint.

type: EndpointType | None

Type of the endpoint.

name: str | None

Name of the endpoint.

auto_and_forced_answer_enabled: bool | None

If true, the endpoint can be remotely controlled, allowing actions such as mute, hold, resume and answer.

owner_id: str | None

Unique identifier of the endpoint owner.

owner_type: UserType | None

Type of the endpoint owner.

secondary_lines: list[MeSecondaryLine] | None

List of secondary lines. The secondary line information is not returned for the endpoint owned by an entity other than the authenticated user.