wxc_sdk.person_settings.push_to_talk module

Person PTT settings API

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

Bases: str, SafeEnum

An enumeration.

one_way = 'ONE_WAY'

Push-to-Talk initiators can chat with this person but only in one direction. The person you enable Push-to-Talk for cannot respond.

two_way = 'TWO_WAY'

Push-to-Talk initiators can chat with this person in a two-way conversation. The person you enable Push-to-Talk for can respond.

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

Bases: str, SafeEnum

An enumeration.

allow_members = 'ALLOW_MEMBERS'

List of people that are allowed to use the Push-to-Talk feature to interact with the person being configured.

block_members = 'BLOCK_MEMBERS'

List of people that are disallowed to interact using the Push-to-Talk feature with the person being configured.

class wxc_sdk.person_settings.push_to_talk.PushToTalkSettings(*, allowAutoAnswer: bool | None = None, connectionType: PTTConnectionType | None = None, accessType: PushToTalkAccessType | None = None, members: list[str | MonitoredMember] | None = None)[source]

Bases: ApiModel

Push To Talk settings

allow_auto_answer: bool | None

Set to true to enable the Push-to-Talk feature. When enabled, a person receives a Push-to-Talk call and answers the call automatically.

connection_type: PTTConnectionType | None

Specifies the connection type to be used.

access_type: PushToTalkAccessType | None

Specifies the access type to be applied when evaluating the member list.

members: list[str | MonitoredMember] | None

List of people that are allowed or disallowed to interact using the Push-to-Talk feature. can be just a member id for a configure() call

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

Bases: PersonSettingsApiChild

API for person’s PTT settings

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

Read Push-to-Talk Settings for a Person Retrieve a Person’s Push-to-Talk Settings

Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.

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:

PTT settings for specific user

Return type:

PushToTalkSettings

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

Configure Push-to-Talk Settings for a Person

Configure a Person’s Push-to-Talk Settings

Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.

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 (PushToTalkSettings) – new setting to be applied. For members only the ID needs to be set

  • org_id – 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 = ''