wxc_sdk.person_settings.callbridge module

class wxc_sdk.person_settings.callbridge.CallBridgeApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

User Call Settings with Call Bridge Feature

Not supported for Webex for Government (FedRAMP)

Person Call Settings supports modifying Webex Calling settings for a specific person.

Viewing People requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read or, for select APIs, a user auth token with spark:people_read scope can be used by a person to read their own settings.

Configuring People settings requires a full or user administrator auth token with the spark-admin:people_write scope or, for select APIs, a user auth token with spark:people_write scope can be used by a person to update their own settings.

feature = 'callBridge'
read(entity_id: str, org_id: str | None = None) → CallBridgeSetting[source]

Read Call Bridge Settings

Retrieve Bridge settings.

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

Parameters:

  • entity_id (str) – Unique identifier for the person.

  • 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:

:class:’CallBridgeSetting’

configure(entity_id: str, setting: CallBridgeSetting, org_id: str | None = None)[source]

Configure Call Bridge Settings

Configure Call Bridge settings.

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

Parameters:

  • entity_id (str) – Unique identifier for the person.

  • setting (:class:'CallBridgeSetting') – new call bridge settings

  • 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:

None

base = ''
class wxc_sdk.person_settings.callbridge.CallBridgeSetting(*, warningToneEnabled: bool)[source]

Bases: ApiModel

warning_tone_enabled: bool

Set to enable or disable a stutter dial tone being played to all the participants when a person is bridged on the active shared line call.