wxc_sdk.person_settings.calling_behavior module

Calling behavior API

class wxc_sdk.person_settings.calling_behavior.BehaviorType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

The Calling Behavior setting for the person

native = 'NATIVE_WEBEX_TEAMS_CALLING'

Calling in Webex Teams(formerly Spark Call), or Hybrid Calling.

cisco_tel = 'CALL_WITH_APP_REGISTERED_FOR_CISCOTEL'

Cisco Jabber app

third_party = 'CALL_WITH_APP_REGISTERED_FOR_TEL'

Third-Party app

webex_calling = 'CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL'

Webex Calling app

native_sip_call_to_ucm = 'NATIVE_SIP_CALL_TO_UCM'

Calling in Webex Teams (Unified CM)

class wxc_sdk.person_settings.calling_behavior.CallingBehavior(*, behaviorType: BehaviorType | None = None, effectiveBehaviorType: BehaviorType | None = None, profileId: str | None = None)[source]

Bases: ApiModel

behavior_type: BehaviorType | None

The current Calling Behavior setting for the person. If null, the effective Calling Behavior will be the Organization’s current default.

effective_behavior_type: BehaviorType | None

The effective Calling Behavior setting for the person, will be the organization’s default Calling Behavior if the user’s behaviorType is set to null.

profile_id: str | None

The UC Manager Profile ID.

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

Bases: PersonSettingsApiChild

API for person’s calling behavior settings

feature = 'callingBehavior'
read(person_id: str, org_id: str | None = None) → CallingBehavior[source]

Read Person’s Calling Behavior

Retrieves the calling behavior and UC Manager Profile settings for the person which includes overall calling behavior and calling UC Manager Profile ID.

Webex Calling Behavior controls which Webex telephony application is to be used.

An organization has an organization-wide default Calling Behavior that may be overridden for individual persons.

In addition, UC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex Teams (Unified CM).

The UC Manager Profile also has an organization-wide default and may be overridden for individual persons.

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

Parameters:

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

  • org_id (str) – Person is in this organization. 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.

Returns:

calling behavior setting

Return type:

CallingBehavior

configure(person_id: str, settings: CallingBehavior, org_id: str | None = None)[source]

Configure a Person’s Calling Behavior

Modifies the calling behavior settings for the person which includes overall calling behavior and UC Manager Profile ID.

Webex Calling Behavior controls which Webex telephony application is to be used.

An organization has an organization-wide default Calling Behavior that may be overridden for individual persons.

In addition, UC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex Teams (Unified CM).

The UC Manager Profile also has an organization-wide default and may be overridden for individual persons.

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

Parameters:

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

  • settings (CallingBehavior) – new settings

  • org_id (str) – Person is in this organization. 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.

base = ''