wxc_sdk.me.secondary_line.endpoints package

API for /me/endpoints

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

Bases: ApiChild

list(line_owner_id: str) → list[MeEndpoint]

Get My Secondary Line Owner’s Available Preferred Answer Endpoint List

Retrieve the list of available preferred answer endpoints for the secondary line owner of the authenticated person.

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:

• line_owner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

• 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(line_owner_id: str) → MeEndpoint

Get My Secondary Line Owner’s Preferred Answer Endpoint

Retrieve the selected preferred answering endpoint for the secondary line owner of the authenticated person. 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.

Parameters:

line_owner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

Return type:

MeEndpoint

modify_preferred_answer_endpoint(line_owner_id: str, id: str)

Modify My Secondary Line Owner’s Preferred Answer Endpoint

Sets or clears the preferred answer endpoint for the secondary line owner of the authenticated person. 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:

• line_owner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

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

Return type:

None

base = 'telephony/config/people/me'