wxc_sdk.person_settings.app_shared_line module

class wxc_sdk.person_settings.app_shared_line.AppSharedLineApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Webex app shared line API

search_members(person_id: str, order: str | None = None, location: str | None = None, name: str | None = None, phone_number: str | None = None, extension: str | None = None, **params) → Generator[AvailableMember, None, None][source]

Search Shared-Line Appearance Members

Get members available for shared-line assignment to a Webex Calling Apps.

Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.

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

Parameters:

  • person_id (str) – A unique identifier for the person.

  • order (str) – Order the Route Lists according to number, ascending or descending.

  • location (str) – Location ID for the user.

  • name (str) – Search for users with names that match the query.

  • phone_number (str) – Search for users with numbers that match the query.

  • extension (str) – Search for users with extensions that match the query.

Returns:

Generator yielding AvailableSharedLineMember instances

search_members_old(person_id: str, application_id: str, max_: str | None = None, start: str | None = None, location: str | None = None, name: str | None = None, number: str | None = None, order: str | None = None, extension: str | None = None, **params) → Generator[AvailableMember, None, None][source]

Search Shared-Line Appearance Members

Get members available for shared-line assignment to a Webex Calling Apps Desktop device.

Deprecated: This operation has been marked as deprecated, which means it could be removed at some point in the future.

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

Parameters:

  • person_id (str) – A unique identifier for the person.

  • application_id (str) – A unique identifier for the application.

  • max (str) – Number of records per page.

  • start (str) – Page number.

  • location (str) – Location ID for the user.

  • name (str) – Search for users with names that match the query.

  • number (str) – Search for users with numbers that match the query.

  • order (str) – Sort by first name (fname) or last name (lname).

  • extension (str) – Search for users with extensions that match the query.

Returns:

Generator yielding AvailableMember instances

get_members(person_id: str) → DeviceMembersResponse[source]

Get Shared-Line Appearance Members

Get primary and secondary members assigned to a shared line on a Webex Calling Apps.

Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.

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

Parameters:

person_id (str) – A unique identifier for the person.

Return type:

DeviceMembersResponse

update_members(person_id: str, members: list[DeviceMember | AvailableMember] | None = None)[source]

Put Shared-Line Appearance Members New

Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps.

Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.

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

Parameters:

  • person_id (str) – A unique identifier for the person.

  • members (list[Union[DeviceMember, AvailableMember]]) – List of members to be added or modified for shared-line assignment to a Webex Calling Apps.

Return type:

None

base = 'telephony/config/people'